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

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
Request
header Parameters
Connect-Region-Code
string

Region Code

Request Body schema:

The values needed to create the future recurring subscription payment

webPaymentMethodId
required
integer <int32>

Gets the unique identifier of the web payment method

redirectReturnUrl
string 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

languageTag
string or null

Gets the IETF (RFC 4646) language tag

subscriptionBillingOptionId
required
string non-empty

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

Responses
200

Success

400

Request property is invalid or missing, or member cannot set a future subscription.

401

No member authenticated.

post/ocapi/v1/members/current/subscriptions/future-recurring/payment-card/embedded
Request samples
{
  • "webPaymentMethodId": 0,
  • "redirectReturnUrl": "http://example.com",
  • "languageTag": "string",
  • "subscriptionBillingOptionId": "string"
}
Response samples
application/json
{
  • "memberPaymentCardId": "string",
  • "webPaymentMethodId": 0,
  • "connectorFunctionName": "string",
  • "connectorParametersJson": "string",
  • "createCardTokenUrl": "http://example.com",
  • "sdkScriptUrls": [
    ],
  • "isButtonIncluded": true,
  • "isPrimaryCardOptionIncluded": true,
  • "connectorScriptUrls": [
    ]
}