Create a subscription

The object type. Always subscription.

The full URL of this subscription.

The subscription id.

When the subscription was created.

When the subscription was last changed.

true for a test subscription, false for a live one.

The account the subscription belongs to.

trial while in a free trial, active while billing, cancelled once cancelled, and completed once the last billing set by end_at_billing_count is done.

true when a renewal payment failed and is being retried. The subscription stays active during the grace period. If no retry succeeds before the grace period in your subscription settings ends, the subscription is cancelled.

How many billing_interval_unit make one billing period. Copied from the subscription plan when the subscription was made.

The unit of the billing period. minute and hour are only allowed on test plans.

The billing period as text, for example 1 month or 3 months.

The trial length in trial_interval_unit. null when there is no trial.

The unit of the trial. null when there is no trial.

The trial length as text, for example 14 days. null when there is no trial.

How many times the subscription has been billed (one invoice per billing period). This is not the number of successful payments: a failed renewal still counts. 0 during a trial.

The number of billings after which the subscription completes. null means it bills until cancelled.

The three-letter ISO 4217 currency the customer pays in. Item prices in another currency are converted at each renewal.

The items the subscription bills for, including cancelled ones.

The shipping method used for physical items on each renewal. null when nothing is shipped.

When the trial started. null when there is no trial.

When the trial ends, or ended. null when there is no trial.

When the current billing period started. null once the subscription is cancelled.

When the current billing period ends. The next renewal is billed at this time. null once the subscription is cancelled.

When the next renewal reminder is sent to the customer. null when reminders are off or none is due. Not returned to a limited token.

When the cancellation was asked for. When a cancellation is scheduled for the period end, this is set at once while the subscription stays active until date_current_period_end. null when not cancelled.

Why the subscription was cancelled: the reason sent with the cancellation, or one set automatically (for example when all items were cancelled). Not returned to a limited token.

true when the subscription is set to be cancelled at the end of the current billing period.

When the subscription ended, by cancellation or completion. For an immediate cancellation it equals date_cancelled. null while the subscription runs.

Items scheduled to be added at the end of the current billing period. Empty when none are scheduled. Remove them all with DELETE /subscriptions/{subscription_id}/add_at_current_period_end.

The subscription plan, as a URL, or the full object with expand=subscription_plan. Later changes to the plan do not change existing subscriptions, so the plan can differ from the values here. Left out when the token may not read subscription plans.

The customer, as a URL, or the full object with expand=customer. Left out when the token may not read customers.

The subscription's invoices, as a URL, or an offset-based list of invoices with expand=invoices (only when you get one subscription, not in a list). The invoices are the billing history. Left out when the token may not read invoices.

The change log, as a URL, or the full object with expand=history (only when you get one subscription). Not returned to a limited token.

Any data you stored on the subscription, up to 2,048 characters.

The dates as display text in the requested locale and time zone. Only returned with formatted=true.