Subscriptions

List Subscriptions

get/subscriptions

Create Subscription

post/subscriptions

Get Subscription

get/subscriptions/{subscription_id}

Cancel Subscription

post/subscriptions/{subscription_id}/cancel

Change Subscription Rate Card

post/subscriptions/{subscription_id}/change-rate-card

ModelsExpand Collapse

CheckoutCallback = object { cancelled_url, success_url }

cancelled_url: string

The URL to redirect to after the checkout is cancelled.

minLength1

formaturi

success_url: string

The URL to redirect to after the checkout is successful.

minLength1

formaturi

SubscriptionResource = object { id, cancels_at_end_of_cycle, current_period, 6 more }

id: string

The ID of the subscription.

cancels_at_end_of_cycle: boolean

Whether the subscription will be cancelled at the end of the current cycle.

current_period: object { end, start, inclusive_end, inclusive_start }

The current period of the subscription if it is active.

end: string

formatdate-time

start: string

formatdate-time

inclusive_end: optional boolean

inclusive_start: optional boolean

cycles_next_at: string

The date and time the next cycle of the subscription will start.

formatdate-time

effective_at: string

The date and time the subscription became effective.

formatdate-time

metadata: map[string]

rate_card_id: string

The ID of the rate card of the subscription.

status: "active" or "cancelled" or "paused"

The status of the subscription.

Accepts one of the following:

"active"

"cancelled"

"paused"

subject_id: string

The ID of the subject that the subscription is for.