Subscription

idstring<uuid>required

merchantIdstring<uuid>required

planNamestringrequired

Possible values: non-empty and <= 120 characters

amountintegerrequired

Possible values: >= 1

currencyCurrencyCode (string)required

Possible values: Value must match regular expression ^[A-Z]{3}$

Examples:

Example 1

Example: USD

Example 2

Example: EUR

Example 3

Example: GBP

intervalSubscriptionInterval (string)required

Possible values: [DAILY, WEEKLY, MONTHLY, YEARLY]

statusSubscriptionStatus (string)required

Possible values: [ACTIVE, PAUSED, CANCELLED, PAST_DUE]

customerIdstring<uuid>required

customerEmailstring<email>required

currentPeriodStartstring<date-time>required

currentPeriodEndstring<date-time>required

metadata objectrequired

property name*string

createdAtstring<date-time>required

updatedAtstring<date-time>required

Subscription

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "planName": "string",
  "amount": 0,
  "currency": "USD",
  "interval": "DAILY",
  "status": "ACTIVE",
  "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerEmail": "[email protected]",
  "currentPeriodStart": "2024-07-29T15:51:28.071Z",
  "currentPeriodEnd": "2024-07-29T15:51:28.071Z",
  "metadata": {},
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}