Skip to main content

SubscriptionSchedule

createdAtstring<date-time>nullable
currentPhaseIndexinteger<int32>required
customerIdstringrequired
endBehaviorSubscriptionScheduleEndBehaviorrequired

Possible values: [RELEASE, CANCEL]

merchantIdstringrequired
phases object[]required
  • Array [
    • couponIdstringnullable
    createdAtstring<date-time>nullable
    endDatestring<date-time>nullable
    iterationsinteger<int32>nullable
    phaseIdstringrequired
    phaseIndexinteger<int32>required
    priceIdstringrequired
    quantityinteger<int32>required
    startDatestring<date-time>nullable
    trialbooleanrequired
  • ]
    • scheduleIdstringrequired
    statusSubscriptionScheduleStatusrequired

    Possible values: [NOT_STARTED, ACTIVE, COMPLETED, CANCELLED]

    subscriptionIdstringnullable
    updatedAtstring<date-time>nullable
    SubscriptionSchedule
    {
      "createdAt": "2024-07-29T15:51:28.071Z",
      "currentPhaseIndex": 0,
      "customerId": "string",
      "endBehavior": "RELEASE",
      "merchantId": "string",
      "phases": [
        {
          "couponId": "string",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "endDate": "2024-07-29T15:51:28.071Z",
          "iterations": 0,
          "phaseId": "string",
          "phaseIndex": 0,
          "priceId": "string",
          "quantity": 0,
          "startDate": "2024-07-29T15:51:28.071Z",
          "trial": true
        }
      ],
      "scheduleId": "string",
      "status": "NOT_STARTED",
      "subscriptionId": "string",
      "updatedAt": "2024-07-29T15:51:28.071Z"
    }