DiscordStatus
Referência / Reference

List subscriptions

get
https://api-sandbox.asaas.com/v3/subscriptions

Lists the subscriptions registered in the account according to the filters provided.

Use this operation to find sets of subscriptions or to perform queries and reconciliations. The response follows the API listing and pagination pattern.

deletedOnly and includeDeleted behave differently: use deletedOnly to return only removed subscriptions and includeDeleted to include removed subscriptions in the general list.

When customer does not match an existing customer in the authenticated account, the query returns an empty list instead of a resource not found error.

📘

Tracking changes

To track subscription creation, updates, deactivation, or removal, use Webhooks instead of repeatedly querying this endpoint.

Use this GET for one-off queries, recovery, or reconciliation.

See the Webhook events for subscriptions.

Related content

Guides

Query Params
integer

List starting element

integer
≤ 100

Number of list elements (max: 100)

string

Filter by Unique Customer Identifier

string

Filter by customer group name

string
enum

Filter by billing type

Allowed:
string
enum

Filter by status

Allowed:
string

Send true to return only removed subscriptions

string

Send true to also recover removed subscriptions

string

Filter by your system identifier

string

Ascending or descending order

string

Which field will it be sorted by

Responses

403

Forbidden. Occurs when the request body is filled, GET method calls must have an empty body.

Updated 7 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago

Did this page help you?