List Subscription Groups
Lists subscription groups for the site. The response is paginated and will return a meta key with pagination information.
Account Balance Information
Account balance information for the subscription groups is not returned by default. If this information is desired, the include[]=account_balances parameter must be provided with the request.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Query Parameters
Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query page=1.
1 <= value1This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query per_page=200.
value <= 20020A list of additional information to include in the response. The following values are supported:
account_balances: Account balance information for the subscription groups. Use in query:include[]=account_balances
Response Body
application/json
curl -X GET "https://example.com/subscription_groups.json"{ "subscription_groups": [ { "uid": "grp_952mvqcnk53wq", "scheme": 1, "customer_id": 88498000, "payment_profile_id": 93063018, "subscription_ids": [ 42768907, 82370782 ], "primary_subscription_id": 69844395, "next_assessment_at": "2021-05-05T16:00:21-04:00", "state": "active", "cancel_at_end_of_period": false, "account_balances": { "prepayments": { "balance_in_cents": 0 }, "service_credits": { "balance_in_cents": 0 }, "pending_discounts": { "balance_in_cents": 0 } } } ], "meta": { "current_page": 1, "total_count": 1 }}Subscription Group Signup POST
Creates multiple subscriptions at once under the same customer and consolidates them into a subscription group. You must provide one and only one of the `payer_id`/`payer_reference`/`payer_attributes` for the customer attached to the group. You must provide one and only one of the `payment_profile_id`/`credit_card_attributes`/`bank_account_attributes` for the payment profile attached to the group. Only one of the `subscriptions` can have `"primary": true` attribute set. When passing a product to a subscription you can use either `product_id` or `product_handle` or `offer_id`. You can also use `custom_price` instead. The subscription request examples below will be split into two sections. The first section, "Subscription Customization", will focus on passing different information with a subscription, such as components, calendar billing, and custom fields. These examples will presume you are using a secure chargify_token generated by Maxio.js (formerly Chargify.js).
Create Subscription Group POST
Creates a subscription group with given members.