Overview
Use subscriptions to process recurring payments for a service or product from your customers.
Subscription status:
- Pending (Unpaid) - there is an invoice, generated, but hasn't been paid.
- Trialing - The user is in a trial period.
- Scheduled - subscription is created but scheduled to start on a future date.
- Paused - subscription can be paused for a maximum of 12 weeks. During this period no invoices are generated (customer is not charged), and there is no access to the products.
- No Collection - there is access to product, invoices are created and voided (or marked 'No collection'). So the customer is not charged.
For details of the objects returned by subscription endpoints, read Subscription object.
Managing Subscriptions
Using the endpoints in this section you can:
You can also manage individual subscription items.
Adding One-time Products
A one-time product purchase can be added to a subscription's invoice as a pending item.
Invoicing
A subscription generates invoices every once in a cycle.
If a subscription has multiple products on it, they will all have recurring payments on the same time period. All products in a subscription are on the same invoice.
To get the latest invoice for a subscription, use the Get upcoming invoice endpoint.