Subscription Groups
Read Subscription Group
Returns subscription group details.
Current Billing Amount in Cents
Current billing amount for the subscription group is not returned by default. If this information is desired, the include[]=current_billing_amount_in_cents parameter must be provided with the request.
Authorization
BasicAuth AuthorizationBasic <token>
The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
uid*string
The uid of the subscription group
Query Parameters
include?array<>
Allows including additional data in the response. Use in query: include[]=current_billing_amount_in_cents.
Response Body
application/json
curl -X GET "https://example.com/subscription_groups/string.json"{ "uid": "grp_939ktzq8v4477", "scheme": 1, "customer_id": 400, "payment_profile_id": 567, "subscription_ids": [ 101, 102, 103 ], "primary_subscription_id": 101, "next_assessment_at": "2020-08-01T14:00:00-05:00", "state": "active", "cancel_at_end_of_period": false, "current_billing_amount_in_cents": 11500, "customer": { "first_name": "Mark", "last_name": "Smith", "organization": "Acme Inc.", "email": "smith@example.com", "reference": "4c92223b-bc16-4d0d-87ff-b177a89a2655" }, "account_balances": { "prepayments": { "balance_in_cents": 0 }, "service_credits": { "balance_in_cents": 0 }, "open_invoices": { "balance_in_cents": 4400 }, "pending_discounts": { "balance_in_cents": 0 } }}