Subscription object

string<uuid>

Id of subscription.

handle

string | null

A unique handle of the subscription.

currency

string<currency>

Currency of the subscription.

Example:

"USD"

term

object

Show child attributes

term.start

string<date>

term.end

string<date> | null

autoRenewal

boolean

For termed subscription, auto renewal is optional and will automatically renew the subscription.

items

object[] | null

Items of the subscription.

Show child attributes

items.id

string<uuid>

Id of the subscription item.

items.billAt

string<date-time> | null

Date and time when to bill the subscription item. Items that bill on the same time is grouped on the same invoice.

items.period

object

Show child attributes

items.period.start

string<date>

items.period.end

string<date> | null

items.quantity

number<double>

The quantity or count of units to be billed. Precision to 4.

items.product

object

Show child attributes

items.product.id

string<uuid>

items.product.name

string | null

items.price

object

Show child attributes

items.price.id

string<uuid>

items.price.name

string | null

createdAt

string<date-time>

Get profile Cancel subscription

⌘I

Welcome

Accounts

Accountsets

Analytics

Authorization

Customers

Discounts

Dunningplans

Environments

Invoices

Paymentproviders

Payments

Prices

Products

Profile

Subscriptions

Templates

Usageevents

Webhooks

Subscription object