List Subscription Components
Built with APIMatic
Advanced Billing Developer Portalv1.0Advanced Billing Developer Portalv1.0Lists a subscription's applied components.
When requesting to list components for a given subscription, if the subscription contains archived components they will be listed in the server response.
The username is a Maxio Chargify API key and the password is x. Basic authentication works only with the US and EU environments, which connect to chargify.com directly. The Maxio API Gateway environment does not accept Basic authentication.
In: header
The Chargify id of the subscription.
The type of filter you'd like to apply to your search. Use in query date_field=updated_at.
Value in
Controls the order in which results are returned.
Use in query direction=asc.
Value in
Filter to use for List Subscription Components operation
The end date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified.
The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site''s time zone will be used. If provided, this parameter will be used instead of end_date.
Allows fetching components allocation only if price point id is present. Use in query price_point_ids=not_null.
Value in
Allows fetching components allocation with matching product family id based on provided ids. Use in query product_family_ids=1,2,3.
The attribute by which to sort. Use in query sort=updated_at.
Value in
The start date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified.
The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site''s time zone will be used. If provided, this parameter will be used instead of start_date.
Allows including additional data in the response. Use in query include=subscription,historic_usages.
If in_use is set to true, it returns only components that are currently in use. However, if it's set to false or not provided, it returns all components connected with the subscription.
application/json
curl -X GET -G \ --url 'https://subdomain.chargify.com/subscriptions/1/components.json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN'