Subscription object

Overview

A subscription object describes a recuring purchase.

📘

To learn more about subscriptions, read About Subscriptions.

Properties

Subscription objects returned by endpoints in this section can have all or some of these properties:

Title	Type	Description
subscriptionItems	Array	Items on this subscription. This is an array of Subscription Item objects.
customer	Object	Object with customer details
customerDescription	String	Customer's description
customerEmail	String	Customer's contact email
status	String	Subscription status. Enum values: "Current", "Scheduled", "Trialing", "Canceled", "Paused", "Unpaid", "Active", "Incomplete", "No Collection"
paymentMethod	String	Payment method
pricingPlan	String	Pricing plan description
paymentMethodId	String	Payment method ID
discountAmount	Number	Discount ammount
currentPeriod	String	Current period
endTrialDate	String	Date and time when the trial ends for this subscription
nextInvoice	String	Next invoice message text
cancelledDate	String	Date and time when the subscription was cancelled
memo	String	Memo text
footer	String	Footer text
paymentDue	String	Payment due date
intervalCountForPayment	Number	How many time units (days, weeks, etc.) should pass between payments
intervalUnitNameForPayment	String	Unit of time to measure the interval between payments. Enum values: "day", "week", "month", "year"
restartBillingPeriod	boolean	Restart billing period
thresholdAmount	Number	Threashold ammount
boletoUrl	String	Boleto URL
pixQrCodeText	String	PIX QR Code
cancelSubscriptionIfPastDue	Boolean	If True, the subscription will be automatically cancelled when an invoice is past due
installments	Number	The number of installments