List Service Credits
Lists a subscription's service credits.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The Chargify id of the subscription.
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 <= 20020Controls the order in which results are returned.
Use in query direction=asc.
Value in
- "asc"
- "desc"
Response Body
application/json
application/json
curl -X GET "https://example.com/subscriptions/0/service_credits/list.json"{ "service_credits": [ { "id": 68, "amount_in_cents": 2200, "ending_balance_in_cents": 1100, "entry_type": "Debit", "memo": "Service credit memo", "invoice_uid": "inv_brntdvmmqxc3j", "remaining_balance_in_cents": 1100, "created_at": "2025-04-01T09:54:49-04:00" }, { "id": 67, "amount_in_cents": 3300, "ending_balance_in_cents": 3300, "entry_type": "Credit", "memo": "Service credit memo", "invoice_uid": null, "remaining_balance_in_cents": 1100, "created_at": "2025-03-05T16:06:08-05:00" } ]}Deduct Service Credit POST
Deducts a service credit from the subscription in the specified amount. The credit amount being deducted must be equal to or less than the current credit balance.
Refund Prepayment POST
Refunds a prepayment applied to a subscription, either fully or partially. The `prepayment_id` will be the account transaction ID of the original payment. The prepayment must have some amount remaining in order to be refunded. The amount may be passed either as a decimal, with `amount`, or an integer in cents, with `amount_in_cents`.