Skip to content

Initiates creation of a future recurring member subscription and also loads and initiates the creation or selection of a member payment card using an embedded UI for the future recurring member subscription

Request

Upon creating or selecting the member payment card, the member's recurring member subscriptions Future will be set.

The GetFutureRecurringSubscriptionCreation endpoint should be polled to determine the status of the future recurring subscription.

Sets Vista as the payment provider for the member subscription, if not already set to Vista.

Licenses Required

  • Vista.Ocapi
  • Vista.Subscriptions
Headers
Connect-Region-Codestring

Region Code

Body

The values needed to create the future recurring subscription payment

webPaymentMethodIdinteger, (int32)required

Gets the unique identifier of the web payment method

redirectReturnUrlstring or null, (uri)

Gets the URL that the browser will be directed to after the embedded payment has finished, if the requested web payment method requires redirect

languageTagstring or null

Gets the IETF (RFC 4646) language tag

subscriptionBillingOptionIdstring, non-emptyrequired

Gets the unique identifier of the subscription billing option that will be regularly charged to the created or selected member payment card

curl -i -X POST \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/subscriptions/future-recurring/payment-card/embedded \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "webPaymentMethodId": 0,
    "redirectReturnUrl": "http://example.com",
    "languageTag": "string",
    "subscriptionBillingOptionId": "string"
  }'

Responses

Success

Bodyapplication/json
memberPaymentCardIdstring, non-emptyrequired

Gets the unique identifier of the member payment card

webPaymentMethodIdinteger, (int32)required

Gets the unique identifier of the web payment method

connectorFunctionNamestring, non-emptyrequired

Gets the name of the connector function that needs to be called

connectorParametersJsonstring, non-emptyrequired

Gets the JSON blob of parameters required by the connector

createCardTokenUrlstring, (uri)required

Gets the create card token URL

sdkScriptUrlsArray of stringsrequired

Gets the list of SDK script URLs that need to be loaded

isButtonIncludedbooleanrequired

Gets a value indicating whether the payment connector UI includes a submit button

isPrimaryCardOptionIncludedbooleanrequired

Gets a value indicating whether the primary card option is included

connectorScriptUrlsArray of stringsrequired

Gets the list of connector script URLs that need to be loaded

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