List Subscriptions
Returns a list of your subscriptions, most recent first. Optionally filter by customer or
status. Use expand (or expand_customer) to inline related objects such as the
customer, latest invoice, item prices, or applied discounts.
Authorizations
Use a Bearer token to access this API.
Query Parameters
Filter by customer ID.
"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
If true, expands the customer object in the response.
false
A cursor for use in pagination. starting_after is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, ending with fsub_xyz, your subsequent call can include starting_after=fsub_xyz to fetch the next page.
"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
A cursor for use in pagination. ending_before is a subscription ID that defines your place in the list. For instance, if you make a list request and receive 20 subscriptions, starting with fsub_abc, your subsequent call can include ending_before=fsub_abc to fetch the previous page.
"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Filter by subscription status.
incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, paused "incomplete"
Number of objects to skip before returning results.
x >= 03
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
x >= 010
Comma-separated list of related objects to expand in the response.
Supported keys: customer; latest_invoice (alias invoice); payment_method; price (alias product); and discounts. Combine discounts with coupons (expand=discounts,coupons) to hydrate each discount's nested source.coupon into a full object instead of a bare ID.
Unrecognized keys are ignored rather than rejected: a misspelled or guessed key (e.g. coupon) returns the same response as no expand at all, with no error.
Response
An envelope wrapping a list of subscription objects.
An envelope wrapping a list of subscription objects.
The list of subscriptions.