PApaddlehq
Subscriptions

List subscriptions

Changed on

Returns a paginated list of subscriptions. Use the query parameters to page through results.

get/subscriptions

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Query parameters

idstring[]

Return only the IDs specified. Use a comma-separated list to get multiple entities.

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

address_idstring[]

Return entities related to the specified address. Use a comma-separated list to specify multiple address IDs.

collection_mode'automatic' | 'manual'

Return entities that match the specified collection mode.

customer_idstring[]

Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

price_idstring[]

Return entities related to the specified price. Use a comma-separated list to specify multiple price IDs.

scheduled_change_actionScheduledChangeActionQuery[]

Return subscriptions that have a scheduled change. Use a comma-separated list to specify multiple scheduled change actions.

next_billed_atstring[] nullable

Return entities next billed at a specific time. Pass null to return entities with no next billing date.

statusSubscriptionStatusQuery[]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

Headers

Skip-Countstring

Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

Response

The request has succeeded.

Changes

  • v14f35a8c6ea4dRevision changes
    • breaking

      added to the /////////// response property oneOf list for the response status

    • breaking

      added to the ///////// response property oneOf list for the response status

    • info

      added the required property //// to the response with the status

  • v1e1ac347eb3c5Revision changes
    • warning

      added the new CLP enum value to the /// response property for the response status

    • warning

      added the new CLP enum value to the //////// response property for the response status

    • warning

      added the new CLP enum value to the ////////// response property for the response status

    • warning

      added the new PEN enum value to the /// response property for the response status

    • warning

      added the new PEN enum value to the //////// response property for the response status

    • warning

      added the new PEN enum value to the ////////// response property for the response status

    • info

      added the new optional header request parameter Skip-Count

    • info

      added the new optional query request parameter next_billed_at

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added to the // response property anyOf list for the response status

    • info

      removed from the // response property anyOf list for the response status

    • info

      added the required property // to the response with the status