Create Subscription

post

https://pg-sandbox.paymaya.com/payments/v1/customers/{customerId}/cards/{cardToken}/subscriptions

Schedules a regularly recurring payment based on a customer's vaulted card.

Path Params

customerId

uuid

required

The unique identification string of a customer record.

cardToken

string

required

The string token representing the card information (only relevant for card-based payments).

Body Params

description

string

required

length between 1 and 255

A descriptive information regarding the subscription.

totalAmount

object

required

Contains the value and currency of the transaction.

interval

string

enum

required

The base unit of time of each scheduled payment of the subscription.

Allowed:

intervalCount

number

required

1 to 1000

Subcription payment recurs every intervalCount of the chosen interval unit of time.

startDate

date

required

The subscription's first payment date in ISO 8601 / RFC 3339 full-date format.

endDate

date

metadata

object

Used to provide additional data to the transaction such a payment faciliator information.

Response

200Successfully created subscription.