Skip to main content

Subscription

Full subscription representation returned by read and mutation endpoints.

subscriptionIdstringrequired
merchantIdstringrequired
customerIdstringrequired
tokenIdstringrequired
planNamestringnullable
amountinteger<int64>required

Recurring amount in integer minor currency units.

currencyCurrencyCode (string)required

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

Examples:
Example: USD
intervalSubscriptionInterval (string)required

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

intervalCountintegerrequired

Possible values: >= 1

statusSubscriptionStatus (string)required

Possible values: [TRIALING, ACTIVE, PAUSED, PAST_DUE, SUSPENDED, CANCELLING, CANCELLED, COMPLETED]

currentCycleintegerrequired

Possible values: >= 0

nextBillingDatestring<date>required
lastBillingDatestring<date>nullable
lastBillingStatusstringnullable
startDatestring<date>required
endDatestring<date>nullable
maxCyclesintegernullable

Possible values: >= 1

failedAttemptsintegerrequired

Possible values: >= 0

cancellationReasonstringnullable
scheduledResumeDatestring<date>nullable
trialStartstring<date>nullable
trialEndstring<date>nullable
trialPeriodDaysintegernullable

Possible values: >= 0

items object[]required
  • Array [
    • idstringrequired
    subscriptionIdstringrequired
    priceIdstringrequired
    productIdstringrequired
    quantityintegerrequired
    descriptionstringnullable
    metadata objectrequired
    property name*string
    unitAmountinteger<int64>required

    Unit amount in integer minor currency units.

    productNamestringnullable
    createdAtstring<date-time>nullable
  • ]
    • metadata objectrequired
    property name*string
    createdAtstring<date-time>nullable
    updatedAtstring<date-time>nullable
    Subscription
    {
      "subscriptionId": "string",
      "merchantId": "string",
      "customerId": "string",
      "tokenId": "string",
      "planName": "string",
      "amount": 0,
      "currency": "USD",
      "interval": "DAILY",
      "intervalCount": 0,
      "status": "TRIALING",
      "currentCycle": 0,
      "nextBillingDate": "2024-07-29",
      "lastBillingDate": "2024-07-29",
      "lastBillingStatus": "string",
      "startDate": "2024-07-29",
      "endDate": "2024-07-29",
      "maxCycles": 0,
      "failedAttempts": 0,
      "cancellationReason": "string",
      "scheduledResumeDate": "2024-07-29",
      "trialStart": "2024-07-29",
      "trialEnd": "2024-07-29",
      "trialPeriodDays": 0,
      "items": [
        {
          "id": "string",
          "subscriptionId": "string",
          "priceId": "string",
          "productId": "string",
          "quantity": 0,
          "description": "string",
          "metadata": {},
          "unitAmount": 0,
          "productName": "string",
          "createdAt": "2024-07-29T15:51:28.071Z"
        }
      ],
      "metadata": {},
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z"
    }