The Subscription Note object stores an internal note attached to a subscription, used to record context, decisions, or history for your team. Notes are never exposed to the customer; they exist purely for internal reference.
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-notes-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 Notes API
version: '1.0'
contact:
email: support@maxio.com
description: 'Operations tagged Subscription Notes 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 Notes
description: 'The Subscription Note object stores an internal note attached to a subscription, used to record context, decisions, or history for your team.
Notes are never exposed to the customer; they exist purely for internal reference.'
paths:
/subscriptions/{subscription_id}/notes.json:
parameters: []
post:
tags:
- Subscription Notes
summary: createSubscriptionNote
description: 'Creates a note for a subscription.
Notes allow you to record information about a particular Subscription in a free text format.
If you have structured data such as birth date, color, etc., consider using Metadata instead.
For more information, see Adding Notes in the product documentation.'
operationId: createSubscriptionNote
parameters:
- name: subscription_id
in: path
description: The Chargify id of the subscription.
required: true
schema:
type: integer
contentEncoding: int32
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateSubscriptionNoteRequest'
- examples:
- note:
body: New test note.
sticky: true
contentMediaType: application/json
examples:
Example:
value:
note:
body: New test note.
sticky: true
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionNoteResponse'
'422':
description: Unprocessable Entity (WebDAV)
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorListResponse1'
- description: Error which contains list of messages.
examples:
- errors:
- 'Body: cannot be blank.'
contentMediaType: application/json
examples:
Blank-Body:
value:
errors:
- 'Body: cannot be blank.'
deprecated: false
get:
tags:
- Subscription Notes
summary: listSubscriptionNotes
description: Retrieves a list of notes associated with a subscription. The response will be an array of Notes.
operationId: listSubscriptionNotes
parameters:
- name: subscription_id
in: path
description: The Chargify id of the subscription.
required: true
schema:
type: integer
contentEncoding: int32
- 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
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SubscriptionNoteResponse'
description: ''
examples:
- - note:
body: Test note.
created_at: '2015-06-15T13:26:47-04:00'
id: 5
sticky: false
subscription_id: 100046
updated_at: '2015-06-15T13:28:12-04:00'
- note:
body: Another test note.
created_at: '2015-06-15T12:04:46-04:00'
id: 4
sticky: false
subscription_id: 100046
updated_at: '2015-06-15T13:26:33-04:00'
contentMediaType: application/json
examples:
Example:
value:
- note:
body: Test note.
created_at: '2015-06-15T13:26:47-04:00'
id: 5
sticky: false
subscription_id: 100046
updated_at: '2015-06-15T13:28:12-04:00'
- note:
body: Another test note.
created_at: '2015-06-15T12:04:46-04:00'
id: 4
sticky: false
subscription_id: 100046
updated_at: '2015-06-15T13:26:33-04:00'
'422':
description: Unprocessable Entity (WebDAV)
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorListResponse1'
- description: Error which contains list of messages.
examples:
- errors:
- 'invalid page: -1'
contentMediaType: application/json
examples:
Invalid-Page:
value:
errors:
- 'invalid page: -1'
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.
/subscriptions/{subscription_id}/notes/{note_id}.json:
parameters: []
get:
tags:
- Subscription Notes
summary: readSubscriptionNote
description: Retrieves a specific note attached to a subscription.
operationId: readSubscriptionNote
parameters:
- name: subscription_id
in: path
description: The Chargify id of the subscription.
required: true
schema:
type: integer
contentEncoding: int32
- name: note_id
in: path
description: The Advanced Billing id of the note
required: true
schema:
type: integer
contentEncoding: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SubscriptionNoteResponse'
- examples:
- note:
body: Test note.
created_at: '2015-06-15T13:26:47-04:00'
id: 5
sticky: false
subscription_id: 100046
updated_at: '2015-06-15T13:28:12-04:00'
contentMediaType: application/json
examples:
Example:
value:
note:
body: Test note.
created_at: '2015-06-15T13:26:47-04:00'
id: 5
sticky: false
subscription_id: 100046
updated_at: '2015-06-15T13:28:12-04:00'
deprecated: false
put:
tags:
- Subscription Notes
summary: updateSubscriptionNote
description: Updates a note for a subscription.
operationId: updateSubscriptionNote
parameters:
- name: subscription_id
in: path
description: The Chargify id of the subscription.
required: true
schema:
type: integer
contentEncoding: int32
- name: note_id
in: path
description: The Advanced Billing id of the note
required: true
schema:
type: integer
contentEncoding: int32
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateSubscriptionNoteRequest'
- examples:
- note:
body: Modified test note.
sticky: true
contentMediaType: application/json
examples:
Example:
value:
note:
body: Modified test note.
sticky: true
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionNoteResponse'
'422':
description: Unprocessable Entity (WebDAV)
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorListResponse1'
- description: Error which contains list of messages.
examples:
- errors:
- 'Body: cannot be blank.'
contentMediaType: application/json
examples:
Blank-Body:
value:
errors:
- 'Body: cannot be blank.'
deprecated: false
delete:
tags:
- Subscription Notes
summary: deleteSubscriptionNote
description: Deletes a note for a Subscription.
operationId: deleteSubscriptionNote
parameters:
- name: subscription_id
in: path
description: The Chargify id of the subscription.
required: true
schema:
type: integer
contentEncoding: int32
- name: note_id
in: path
description: The Advanced Billing id of the note
required: true
schema:
type: integer
contentEncoding: int32
responses:
'200':
description: OK
headers: {}
content: {}
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:
ErrorListResponse1:
title: ErrorListResponse1
required:
- errors
type: object
properties:
errors:
type: array
items:
type: string
description: ''
description: Error which contains list of messages.
SubscriptionNote:
title: SubscriptionNote
type: object
properties:
id:
type: integer
contentEncoding: int32
body:
type: string
subscription_id:
type: integer
contentEncoding: int32
created_at:
type: string
contentEncoding: date-time
updated_at:
type: string
contentEncoding: date-time
sticky:
type: boolean
SubscriptionNoteResponse:
title: SubscriptionNoteResponse
required:
- note
type: object
properties:
note:
$ref: '#/components/schemas/SubscriptionNote'
UpdateSubscriptionNoteRequest:
title: UpdateSubscriptionNoteRequest
required:
- note
type: object
properties:
note:
allOf:
- $ref: '#/components/schemas/UpdateSubscriptionNote'
- description: Updatable fields for Subscription Note
description: Updatable fields for Subscription Note
UpdateSubscriptionNote:
title: UpdateSubscriptionNote
required:
- body
- sticky
type: object
properties:
body:
type: string
sticky:
type: boolean
description: Updatable fields for Subscription Note
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)