The Subscription Group Invoice Account object lets you manage prepayments and service credits for the shared invoice account of a Subscription Group, applying at the group level rather than to an individual subscription.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/maxio:maxio-subscription-group-invoice-account-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Maxio Subscription Group Invoice Account API
version: '1.0'
contact:
email: support@maxio.com
description: 'Operations tagged Subscription Group Invoice Account across 2 of this provider''s published API definitions: maxio-advanced-billing-openapi31json.json, maxio-advanced-billing-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{site}.chargify.com
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://{site}.ebilling.maxio.com
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
security:
- BasicAuth: []
tags:
- name: Subscription Group Invoice Account
description: The Subscription Group Invoice Account object lets you manage prepayments and service credits for the shared invoice account of a Subscription Group, applying at the group level rather than to an individual subscription.
paths:
/subscription_groups/{uid}/prepayments.json:
parameters: []
post:
tags:
- Subscription Group Invoice Account
summary: createSubscriptionGroupPrepayment
description: 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.
operationId: createSubscriptionGroupPrepayment
parameters:
- name: uid
in: path
description: The uid of the subscription group
required: true
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionGroupPrepaymentRequest'
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SubscriptionGroupPrepaymentResponse'
- examples:
- id: 6049554
amount_in_cents: 10000
ending_balance_in_cents: 5000
entry_type: Debit
memo: Debit from invoice account.
contentMediaType: application/json
examples:
Example:
value:
id: 6049554
amount_in_cents: 10000
ending_balance_in_cents: 5000
entry_type: Debit
memo: Debit from invoice account.
'422':
description: Unprocessable Entity (WebDAV)
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorListResponse1'
- description: Error which contains list of messages.
examples:
- errors:
- Amount must be greater than 0
contentMediaType: application/json
examples:
Example:
value:
errors:
- Amount must be greater than 0
deprecated: false
get:
tags:
- Subscription Group Invoice Account
summary: listPrepaymentsForSubscriptionGroup
description: Lists a subscription group's prepayments.
operationId: listPrepaymentsForSubscriptionGroup
parameters:
- name: uid
in: path
description: The uid of the subscription group
required: true
schema:
type: string
- name: page
in: query
description: '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`.'
style: form
explode: true
schema:
minimum: 1.0
type: integer
contentEncoding: int32
default: 1
examples:
- 1
- name: per_page
in: query
description: 'This 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`.'
style: form
explode: true
schema:
maximum: 200.0
type: integer
contentEncoding: int32
default: 20
examples:
- 50
- name: filter
in: query
description: Filter to use for List Prepayments operations
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/ListPrepaymentsFilter'
- description: Filter to use for List Prepayments operations
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ListSubscriptionGroupPrepaymentResponse'
- examples:
- prepayments:
- prepayment:
id: 142
subscription_group_uid: grp_b4qhx3bvx72t8
amount_in_cents: 10000
remaining_amount_in_cents: 10000
details: test
external: true
memo: test
payment_type: cash
created_at: '2023-06-21T04:37:02-04:00'
contentMediaType: application/json
examples:
example-success-response:
value:
prepayments:
- prepayment:
id: 142
subscription_group_uid: grp_b4qhx3bvx72t8
amount_in_cents: 10000
remaining_amount_in_cents: 10000
details: test
external: true
memo: test
payment_type: cash
created_at: '2023-06-21T04:37:02-04:00'
'404':
description: Not Found
headers: {}
content: {}
deprecated: false
security:
- BasicAuth: []
servers:
- url: https://{site}.chargify.com
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://{site}.ebilling.maxio.com
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
/subscription_groups/{uid}/service_credits.json:
parameters: []
post:
tags:
- Subscription Group Invoice Account
summary: issueSubscriptionGroupServiceCredit
description: 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.
operationId: issueSubscriptionGroupServiceCredit
parameters:
- name: uid
in: path
description: The uid of the subscription group
required: true
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/IssueServiceCreditRequest'
- examples:
- service_credit:
amount: 10
memo: Credit the group account
contentMediaType: application/json
examples:
Example:
value:
service_credit:
amount: 10
memo: Credit the group account
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ServiceCreditResponse'
- examples:
- service_credit:
id: 101
amount_in_cents: 1000
ending_balance_in_cents: 2000
entry_type: Credit
memo: Credit to group account
contentMediaType: application/json
examples:
Example:
value:
service_credit:
id: 101
amount_in_cents: 1000
ending_balance_in_cents: 2000
entry_type: Credit
memo: Credit to group account
'422':
description: Unprocessable Entity (WebDAV)
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorListResponse1'
- description: Error which contains list of messages.
examples:
- errors:
- Amount must be greater than 0
contentMediaType: application/json
examples:
Example:
value:
errors:
- Amount must be greater than 0
deprecated: false
servers:
- url: https://{site}.chargify.com
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://{site}.ebilling.maxio.com
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
/subscription_groups/{uid}/service_credit_deductions.json:
parameters: []
post:
tags:
- Subscription Group Invoice Account
summary: deductSubscriptionGroupServiceCredit
description: Deducts service credit for a subscription group. Credit will be deducted from the group in the amount specified in the request body.
operationId: deductSubscriptionGroupServiceCredit
parameters:
- name: uid
in: path
description: The uid of the subscription group
required: true
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DeductServiceCreditRequest'
- examples:
- deduction:
amount: 10
memo: Deduct from group account
contentMediaType: application/json
examples:
Example:
value:
deduction:
amount: 10
memo: Deduct from group account
required: false
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ServiceCredit'
- examples:
- id: 100
amount_in_cents: 1000
ending_balance_in_cents: 0
entry_type: Debit
memo: Debit from group account
contentMediaType: application/json
examples:
Example:
value:
id: 100
amount_in_cents: 1000
ending_balance_in_cents: 0
entry_type: Debit
memo: Debit from group account
'422':
description: Unprocessable Entity (WebDAV)
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorListResponse1'
- description: Error which contains list of messages.
examples:
- errors:
- Amount must be greater than 0
contentMediaType: application/json
examples:
Example:
value:
errors:
- Amount must be greater than 0
deprecated: false
servers:
- url: https://{site}.chargify.com
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://{site}.ebilling.maxio.com
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
components:
schemas:
IssueServiceCredit:
title: IssueServiceCredit
required:
- amount
type: object
properties:
amount:
oneOf:
- minimum: 0.0
type: number
- type: string
memo:
type: string
ErrorListResponse1:
title: ErrorListResponse1
required:
- errors
type: object
properties:
errors:
type: array
items:
type: string
description: ''
description: Error which contains list of messages.
SubscriptionGroupPrepaymentRequest:
title: SubscriptionGroupPrepaymentRequest
required:
- prepayment
type: object
properties:
prepayment:
$ref: '#/components/schemas/SubscriptionGroupPrepayment'
ServiceCreditResponse:
title: ServiceCreditResponse
required:
- service_credit
type: object
properties:
service_credit:
$ref: '#/components/schemas/ServiceCredit'
SubscriptionGroupPrepayment:
title: SubscriptionGroupPrepayment
required:
- amount
- details
- memo
- method
type: object
properties:
amount:
type: integer
contentEncoding: int32
details:
type: string
memo:
type: string
method:
$ref: '#/components/schemas/SubscriptionGroupPrepaymentMethod'
ServiceCreditType:
title: ServiceCreditType
enum:
- Credit
- Debit
type: string
description: The type of entry
IssueServiceCreditRequest:
title: IssueServiceCreditRequest
required:
- service_credit
type: object
properties:
service_credit:
$ref: '#/components/schemas/IssueServiceCredit'
DeductServiceCredit:
title: DeductServiceCredit
required:
- amount
type: object
properties:
amount:
oneOf:
- type: string
- type: number
memo:
type: string
PrepaymentMethod:
title: PrepaymentMethod
enum:
- check
- cash
- money_order
- ach
- paypal_account
- credit_card
- other
type: string
ListSubscriptionGroupPrepaymentResponse:
title: ListSubscriptionGroupPrepaymentResponse
required:
- prepayments
type: object
properties:
prepayments:
type: array
items:
$ref: '#/components/schemas/ListSubscriptionGroupPrepayment'
description: ''
SubscriptionGroupPrepaymentMethod:
title: SubscriptionGroupPrepaymentMethod
enum:
- check
- cash
- money_order
- ach
- paypal_account
- other
type: string
ServiceCredit:
title: ServiceCredit
type: object
properties:
id:
type: integer
contentEncoding: int32
amount_in_cents:
type: integer
description: The amount in cents of the entry
contentEncoding: int64
ending_balance_in_cents:
type: integer
description: The new balance for the credit account
contentEncoding: int64
entry_type:
allOf:
- $ref: '#/components/schemas/ServiceCreditType'
- description: The type of entry
memo:
type: string
description: The memo attached to the entry
DeductServiceCreditRequest:
title: DeductServiceCreditRequest
required:
- deduction
type: object
properties:
deduction:
$ref: '#/components/schemas/DeductServiceCredit'
ListSubscriptionGroupPrepayment:
title: ListSubscriptionGroupPrepayment
required:
- prepayment
type: object
properties:
prepayment:
$ref: '#/components/schemas/ListSubscriptionGroupPrepaymentItem'
ListSubscriptionGroupPrepaymentItem:
title: ListSubscriptionGroupPrepaymentItem
type: object
properties:
id:
type: integer
contentEncoding: int32
subscription_group_uid:
type: string
amount_in_cents:
type: integer
contentEncoding: int64
remaining_amount_in_cents:
type: integer
contentEncoding: int64
details:
type: string
external:
type: boolean
memo:
type: string
payment_type:
$ref: '#/components/schemas/PrepaymentMethod'
created_at:
type: string
contentEncoding: date-time
ListPrepaymentDateField:
title: ListPrepaymentDateField
enum:
- created_at
- application_at
type: string
examples:
- created_at
ListPrepaymentsFilter:
title: ListPrepaymentsFilter
type: object
properties:
date_field:
allOf:
- $ref: '#/components/schemas/ListPrepaymentDateField'
- description: The type of filter you would like to apply to your search. `created_at` - Time when prepayment was created. `application_at` - Time when prepayment was applied to invoice. Use in query `filter[date_field]=created_at`.
examples:
- created_at
start_date:
type: string
description: 'The start date (format YYYY-MM-DD) with which to filter the date_field. Returns prepayments with a timestamp at or after midnight (12:00:00 AM) in your site''s time zone on the date specified. Use in query: `filter[start_date]=2011-12-15`.'
contentEncoding: date
examples:
- '2024-01-01'
end_date:
type: string
description: 'The end date (format YYYY-MM-DD) with which to filter the date_field. Returns prepayments with a timestamp up to and including 11:59:59PM in your site''s time zone on the date specified. Use in query: `filter[end_date]=2011-12-15`.'
contentEncoding: date
examples:
- '2024-01-31'
SubscriptionGroupPrepaymentResponse:
title: SubscriptionGroupPrepaymentResponse
type: object
properties:
id:
type: integer
contentEncoding: int32
amount_in_cents:
type: integer
description: The amount in cents of the entry.
contentEncoding: int64
ending_balance_in_cents:
type: integer
description: The ending balance in cents of the account.
contentEncoding: int64
entry_type:
allOf:
- $ref: '#/components/schemas/ServiceCreditType'
- description: The type of entry
memo:
type:
- string
- 'null'
description: A memo attached to the entry.
securitySchemes:
BasicAuth:
type: http
description: The `username` is a Maxio Chargify API key. The `password` is `x`.
scheme: basic
x-refined-from:
- maxio-advanced-billing-openapi31json.json
- maxio-advanced-billing-openapi.yml
x-provenance:
method: harvested
publisher: Maxio
source: https://developers.maxio.com/static/exports/maxio-advanced-billing-openapi31json.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)