Subscription item resource - Developer documentation

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "subtitle": "<string>",
  "quantity": 2,
  "totalPrice": 1,
  "recurringCycleLimit": 2,
  "canceledAt": "2023-11-07T05:31:56Z",
  "billingPolicy": {
    "intervalCount": 183,
    "anchors": [
      {
        "day": 16,
        "month": 6,
        "cutoffDay": 16
      }
    ],
    "minCycles": 2,
    "maxCycles": 2
  },
  "deliveryPolicy": {
    "intervalCount": 183,
    "anchors": [
      {
        "day": 16,
        "month": 6,
        "cutoffDay": 16
      }
    ]
  },
  "variant": "<string>",
  "product": "<string>"
}

The SubscriptionItem object defines which products are included in a subscription and how they are configured. It supports multiple variants and can be configured for specific subscription cycles, allowing customers to customize their subscription with different product options.

Reference

string<uuid>

required

resource

enum<string>

required

Available options:

subscription-item

title

string

required

Minimum string length: 1

subtitle

null | string

required

Matches the variant title in most cases

Minimum string length: 1

quantity

integer

required

Required range: x >= 1

totalPrice

number

required

Final item price including all discounts and taxes

Required range: x >= 0

recurringCycleLimit

null | integer

required

The number of billing cycles for which this item will be applied. After the recurring cycle limit is met the item will be removed from the subscription.

Required range: x >= 1

canceledAt

null | string<date-time>

required

Cancellation date of the item.

billingPolicy

BillingPolicy · object

required

Show child attributes

deliveryPolicy

DeliveryPolicy · object

required

Show child attributes

variant

required

This field is expandable.

Minimum string length: 1

product

required

This field is expandable.

Minimum string length: 1

Reactivate subscription Create a subscription item

⌘I

Documentation Index

​Reference

Reference