mammoth-io Billing Actions Support API
The Billing Actions Support API from mammoth-io — 6 operation(s) for billing actions support.
The Billing Actions Support API from mammoth-io — 6 operation(s) for billing actions support.
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/mammoth-io:mammoth-io-billing-actions-support-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. 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: Mammoth Io Billing Actions Support API
version: 0.1.0
contact:
name: Mammoth Analytics
url: https://mammoth.io
email: support@mammoth.io
description: 'Operations tagged Billing Actions Support across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
apiSecret: []
workspaceId: []
tags:
- name: Billing Actions Support
paths:
/support/billing/{workspace_id}/cancel-subscription:
post:
tags:
- Billing Actions Support
summary: Cancel a workspace's subscription (or its deal), now or at period end
description: '`now`: billing stops today, the unused time becomes credit on the customer (no refund) and the workspace lands on Free. `period_end`: the workspace keeps its plan until the paid period ends. A live deal is cancelled instead (a partner deal: `now` only). Refused when there is nothing to cancel, for a Chargebee workspace, and when a cancellation at period end is already scheduled.'
operationId: SupportCancelSubscription
parameters:
- name: workspace_id
in: path
schema:
type: integer
required: true
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CancelSubscriptionData'
required: true
responses:
'200':
description: Request fulfilled, document follows
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CancelOutcome'
'400':
description: Bad request syntax or unsupported method
content:
application/json:
schema:
oneOf:
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Client Error
examples:
- status_code: 400
detail: Bad Request
extra: {}
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Validation Exception
examples:
- status_code: 400
detail: Bad Request
extra: {}
'403':
description: Request forbidden -- authorization will not help
content:
application/json:
schema:
properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Authorization Exception
examples:
- status_code: 403
detail: Forbidden
extra: {}
deprecated: false
servers:
- url: /api/v2
/support/billing/{workspace_id}/change-plan:
post:
tags:
- Billing Actions Support
summary: Change a workspace's self-serve plan
operationId: SupportChangePlan
parameters:
- name: workspace_id
in: path
schema:
type: integer
required: true
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangePlanData'
required: true
responses:
'200':
description: Request fulfilled, document follows
headers: {}
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ActionMessage'
- $ref: '#/components/schemas/ChargebeeMoved'
'400':
description: Bad request syntax or unsupported method
content:
application/json:
schema:
oneOf:
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Client Error
examples:
- status_code: 400
detail: Bad Request
extra: {}
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Validation Exception
examples:
- status_code: 400
detail: Bad Request
extra: {}
'403':
description: Request forbidden -- authorization will not help
content:
application/json:
schema:
properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Authorization Exception
examples:
- status_code: 403
detail: Forbidden
extra: {}
deprecated: false
servers:
- url: /api/v2
/support/billing/{workspace_id}/end-trial:
post:
tags:
- Billing Actions Support
summary: End trial and start billing
operationId: SupportEndTrial
parameters:
- name: workspace_id
in: path
schema:
type: integer
required: true
deprecated: false
responses:
'200':
description: Request fulfilled, document follows
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ActionMessage'
'400':
description: Bad request syntax or unsupported method
content:
application/json:
schema:
oneOf:
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Client Error
examples:
- status_code: 400
detail: Bad Request
extra: {}
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Validation Exception
examples:
- status_code: 400
detail: Bad Request
extra: {}
'403':
description: Request forbidden -- authorization will not help
content:
application/json:
schema:
properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Authorization Exception
examples:
- status_code: 403
detail: Forbidden
extra: {}
deprecated: false
servers:
- url: /api/v2
/support/billing/{workspace_id}/refund:
post:
tags:
- Billing Actions Support
summary: Refund a workspace's most recent payment (full, or partial via ?amount cents)
operationId: SupportRefund
parameters:
- name: workspace_id
in: path
schema:
type: integer
required: true
deprecated: false
- name: amount
in: query
schema:
oneOf:
- type: integer
- type: 'null'
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
responses:
'200':
description: Request fulfilled, document follows
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ActionResult'
'400':
description: Bad request syntax or unsupported method
content:
application/json:
schema:
oneOf:
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Client Error
examples:
- status_code: 400
detail: Bad Request
extra: {}
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Validation Exception
examples:
- status_code: 400
detail: Bad Request
extra: {}
'403':
description: Request forbidden -- authorization will not help
content:
application/json:
schema:
properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Authorization Exception
examples:
- status_code: 403
detail: Forbidden
extra: {}
deprecated: false
servers:
- url: /api/v2
/support/billing/{workspace_id}/retry-payment:
post:
tags:
- Billing Actions Support
summary: Retry payment for a past-due workspace
operationId: SupportRetryPayment
parameters:
- name: workspace_id
in: path
schema:
type: integer
required: true
deprecated: false
responses:
'200':
description: Request fulfilled, document follows
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ActionResult'
'400':
description: Bad request syntax or unsupported method
content:
application/json:
schema:
oneOf:
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Client Error
examples:
- status_code: 400
detail: Bad Request
extra: {}
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Validation Exception
examples:
- status_code: 400
detail: Bad Request
extra: {}
'403':
description: Request forbidden -- authorization will not help
content:
application/json:
schema:
properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Authorization Exception
examples:
- status_code: 403
detail: Forbidden
extra: {}
deprecated: false
servers:
- url: /api/v2
/support/billing/{workspace_id}/start-trial:
post:
tags:
- Billing Actions Support
summary: Start a Pro trial on an existing workspace
description: Replace the workspace's billing with a Pro trial (no card needed) for `days` days, default the Pro plan's trial length. Ignores an earlier trial. Refused for a live deal, a partner-billed, a Chargebee-billed or a deleted workspace.
operationId: SupportStartTrial
parameters:
- name: workspace_id
in: path
schema:
type: integer
required: true
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StartTrialData'
required: true
responses:
'200':
description: Request fulfilled, document follows
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TrialStarted'
'400':
description: Bad request syntax or unsupported method
content:
application/json:
schema:
oneOf:
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Client Error
examples:
- status_code: 400
detail: Bad Request
extra: {}
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Validation Exception
examples:
- status_code: 400
detail: Bad Request
extra: {}
'403':
description: Request forbidden -- authorization will not help
content:
application/json:
schema:
properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Authorization Exception
examples:
- status_code: 403
detail: Forbidden
extra: {}
deprecated: false
servers:
- url: /api/v2
components:
schemas:
ChargebeeMoved:
properties:
message:
type: string
chargebee:
type: object
type: object
required:
- chargebee
- message
title: ChargebeeMoved
StartTrialData:
properties:
days:
oneOf:
- type: integer
- type: 'null'
maximum: 60
minimum: 1
type: object
required: []
title: StartTrialData
ActionResult:
properties:
message:
type: string
result:
type: object
type: object
required:
- message
- result
title: ActionResult
ChangePlanData:
properties:
new_plan_id:
type: integer
when:
type: string
default: now
storage_gb:
oneOf:
- type: integer
- type: 'null'
type: object
required:
- new_plan_id
title: ChangePlanData
ActionMessage:
properties:
message:
type: string
type: object
required:
- message
title: ActionMessage
CancelOutcome:
properties:
message:
type: string
when:
type: string
effective_at:
oneOf:
- type: string
- type: 'null'
deal_id:
oneOf:
- type: integer
- type: 'null'
type: object
required:
- message
- when
title: CancelOutcome
TrialStarted:
properties:
message:
type: string
trial:
type: object
type: object
required:
- message
- trial
title: TrialStarted
CancelSubscriptionData:
properties:
when:
type: string
enum:
- now
- period_end
type: object
required:
- when
title: CancelSubscriptionData
securitySchemes:
bearerAuth:
type: http
description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
scheme: bearer
apiKey:
type: apiKey
description: Deprecated — use bearerAuth.
name: X-API-KEY
in: header
apiSecret:
type: apiKey
description: Deprecated — use bearerAuth.
name: X-API-SECRET
in: header
workspaceId:
type: apiKey
description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
name: X-WORKSPACE-ID
in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json