v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB

Subscriptions

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.

post/ocapi/v1/members/current/subscriptions/future-recurring/payment-card/embedded

Connect-Region-Codestring

Region Code

webPaymentMethodIdinteger required

Gets the unique identifier of the web payment method

redirectReturnUrlstring uri nullable

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 nullable

Gets the IETF (RFC 4646) language tag

subscriptionBillingOptionIdstring required

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

Success

memberPaymentCardIdstring required

Gets the unique identifier of the member payment card

webPaymentMethodIdinteger required

Gets the unique identifier of the web payment method

connectorFunctionNamestring required

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

connectorParametersJsonstring required

Gets the JSON blob of parameters required by the connector

createCardTokenUrlstring uri required

Gets the create card token URL

sdkScriptUrlsstring[] required

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

isButtonIncludedboolean required

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

isPrimaryCardOptionIncludedboolean required

Gets a value indicating whether the primary card option is included

connectorScriptUrlsstring[] required

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