Skip to main content
​
merchant
object
required
​
id
string
required

Unique identifier for the subscription.

Example:

"13da3c28-a068-4642-9ce2-b730cfda5f5f"

​
external_id
string
required

External identifier for the subscription provided by the merchant.

Example:

"a9x7bq2lmw5p"

​
name
string
required

Human-readable subscription name as displayed by the merchant.

Example:

"Disney+, Hulu Bundle Premium"

​
status
enum<string>
required

Status of the subscription.

Available options:
ACTIVE,
ACTIVE_CANCELLATION,
ACTIVE_PLAN_CHANGE,
UNRECOGNIZED
Example:

"ACTIVE"

​
billing_cycle
enum<string>
required

Billing cycle of the subscription.

Available options:
MONTHLY,
WEEKLY,
ANNUALLY,
DAILY,
UNRECOGNIZED
Example:

"MONTHLY"

​
price
object
required
​
next_billing_date
string<date-time> | null

Timestamp of the next scheduled charge date in UTC. ISO 8601 format.

Example:

"2026-02-10T00:00:00+00:00"

​
last_billing_date
string<date-time> | null

Timestamp of the most recent attempted charge date in UTC. ISO 8601 format.

Example:

"2026-01-10T00:00:00+00:00"