Recurring subscription payment cards

A member with a recurring subscription must authorise a payment card with Strong Customer Authentication (SCA) for the billing amount and frequency of their recurring subscription billing option.

Get current recurring payment card

The member's current recurring payment card is indicated by the isUsedForRecurringSubscriptionBilling property of their member payment cards.

Update recurring payment card

A member with a recurring subscription may update their recurring payment card at any time. The updated recurring payment card will be billed for their next subscription billing period.

Member eligibility

A member is eligible to change their recurring payment card when:

They have a recurring subscription that's Active or OnHold and hasn't been cancelled, or
They have purchased a future recurring subscription.

NOTE

Members with a Frozen recurring subscription due to a billing error can update their recurring payment card and restore their subscription benefits by reactivating their subscription.

Update recurring payment card flow

Member authentication

Authenticate the member and check that they are eligible to change their payment card.

Create recurring subscription payment card

Use the CreateRecurringSubscriptionEmbeddedPaymentCard endpoint to create a new recurring payment card for the member's subscription.

Copy

Copied

{
  "webPaymentMethodId": 0,
  "redirectReturnUrl": "http://example.com",
  "languageTag": "string"
}

This endpoint returns the details required to render an embedded payment UI for the member to authorise their payment card.

Copy

Copied

{
  "memberPaymentCardId": "string",
  "webPaymentMethodId": 0,
  "connectorFunctionName": "string",
  "connectorParametersJson": "string",
  "createCardTokenUrl": "http://example.com",
  "sdkScriptUrls": ["string"],
  "isButtonIncluded": true,
  "isPrimaryCardOptionIncluded": true,
  "connectorScriptUrls": ["string"]
}

NOTE

For access to embedded payment UI reference code, talk to your local Vista representative.

Switch to Vista recurring billing (optional)

If a member is using a third-party payment provider for recurring subscription billing, they may update their subscription to use Vista billing.

See switch to Vista recurring billing for more information.