Get
Authorizations
API key authentication
Path Parameters
Response
Subscription details
subscription The merchant organization that owns this subscription, equal to the customer's merchant.
^org_[a-zA-Z0-9]+$pending_payment, active, terminated Payment term in days ("Net X") snapshotted onto every invoice the subscription generates (invoice dueAt = invoice issue date + paymentTermDays). Defaults to 0 ("due on issue"); a non-zero value is only set on bankTransferOnly subscriptions.
0 <= x <= 365Whether automatic charging is enabled for this subscription. When true, invoices will be automatically paid using stored payment methods.
Projected tax percentage rate. Sample values: 8.875 indicates 8.875% tax rate, 10.0 indicates 10% tax rate, 0 indicates no tax applied
When true, tax rate is forced to 0%.
Payment session details when upfront payment is required, or confirmation of a zero-amount paid invoice
- Option 1
- Option 2
- Option 3
The plan version pinned to this subscription at creation.
The version number of the plan version referenced by planVersionId, as of subscription creation.
x >= 1Deprecated. Legacy-only, not populated for new subscriptions.
Deprecated. Legacy-only, not populated for new subscriptions.
ID of who terminated the subscription (customer ID or merchant ID)
Reason for termination
Test clock ID if this subscription is attached to a test clock. Only present in non-production environments.
Deprecated. Legacy-only, not populated for new subscriptions.
Whether renewal reminder emails are enabled for this subscription. Null means use plan default.
Number of days before renewal to send the reminder. Null means use plan default.
Subscription-level auto-approval override. Null means plan default is used.
Free-form merchant metadata to attach to the subscription. Values must be strings, numbers, or booleans.
Customer details with merchant and consumer information. Only included when include=customer is specified in the list query.