Maxio Advanced Billing
HomeSDKsAPI ReferenceContext Plugin
Subscription Group Invoice Account

Issue Subscription Group Service Credit

POST
/subscription_groups/{uid}/service_credits.json

Issues service credit for a subscription group. Credit will be added to the group in the amount specified in the request body. The credit will be applied to group member invoices as they are generated.

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

Request Body

application/json

service_credit*

Response Body

application/json

application/json

curl -X POST "https://example.com/subscription_groups/string/service_credits.json" \  -H "Content-Type: application/json" \  -d '{    "service_credit": {      "amount": 10,      "memo": "Credit the group account"    }  }'
{  "service_credit": {    "id": 101,    "amount_in_cents": 1000,    "ending_balance_in_cents": 2000,    "entry_type": "Credit",    "memo": "Credit to group account"  }}

Create Subscription Group Prepayment POST

Adds a prepayment for a subscription group. This endpoint requires an `amount`, `details`, `method`, and `memo`. On success, the prepayment will be added to the group's prepayment balance.

Deduct Subscription Group Service Credit POST

Deducts service credit for a subscription group. Credit will be deducted from the group in the amount specified in the request body.