Save the payment profile

post

https://api.emaktalk.com/api/v1/billing/profiles

Creates or updates the payment profile that automatic payments draw on for one customer and subscription, and records the change in the billing action log. This changes how the account gets paid: automatic collection is always turned off on the subscription first, even when you are enabling auto-pay here, so collection runs from this profile instead. The two writes are not atomic — if saving the profile fails after collection has been turned off, the subscription is left with neither. A new profile starts with three retry attempts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customerId

string

required

The billing customer this profile belongs to. Required, and must be your account's.

subscriptionId

string

required

The subscription this profile pays. Required, and must be one of your account's.

autoPayEnabled

boolean

Whether this profile pays automatically. Defaults to false, so omitting it leaves auto-pay off.

gatewayCustomerProfileId

string

The customer's profile ID at the payment gateway; resolved from the payment profile when omitted.

gatewayPaymentProfileId

string

The card or mandate at the payment gateway that this profile charges by default.

cardLastFour

string

Last four digits of the card, stored for display.

cardType

string

Card type, stored for display.

cardExpiryMonth

number

Card expiry month; stored as sent, with no range check.

cardExpiryYear

number

Card expiry year; stored as sent, with no range check.

cardholderName

string

Cardholder name used when logging a card change; not stored on the profile itself.

gateway

string

enum

Which payment gateway the profile uses. Omitted on an update it keeps the current gateway; omitted on a new profile it falls back to the default card gateway.

Allowed:

currency

string

Currency the profile charges in; defaults to CAD, on updates as well as new profiles.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The saved payment profile.

400The body was invalid JSON, or customerId or subscriptionId was missing.

401The request is not authenticated.

403Your API key lacks the Admin role, or the customer or subscription does not belong to your account.

500The profile could not be saved.

502Automatic collection could not be turned off on the subscription, so nothing was saved.