Sign in

v1

latestOpenAPI 3.0.12026-07-14134373.9 KB
Recurring Service

Create recurring payment

Sets up a recurring payment using the specified subscription, stored payment method, item, and schedule.

post/recurring/setup

Request body

subscriptionIdstring required

Unique subscription identifier associated with the customer and stored payment method.

paymentType'creditcard' | 'echeck' required

Type of payment method.

storedPaymentMethodIdstring required

Identifier of the stored payment method to be used for recurring payments.

recurringFrequency'daily' | 'weekly' | 'monthly' | 'bi_weekly' | 'bi_monthly' | 'annually' required

Recurring payment frequency.

recurringStartDatestring date required

Start date of the recurring schedule.

recurringEndDatestring date

End date of the recurring schedule. If provided, no payments are scheduled after this date.

Response

Recurring payment setup completed successfully

subscriptionIdstring

Unique subscription identifier associated with the recurring payment setup.

recurringIdstring

Unique identifier of the recurring payment setup.

httpStatusCodeinteger

HTTP status code.

messagestring

Response message.

responseTimestampstring date-time

Date and time when the response was generated.