mammoth-io Subscriptions Support API
The Subscriptions Support API from mammoth-io — 2 operation(s) for subscriptions support.
The Subscriptions Support API from mammoth-io — 2 operation(s) for subscriptions 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-subscriptions-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 Subscriptions Support API
version: 0.1.0
contact:
name: Mammoth Analytics
url: https://mammoth.io
email: support@mammoth.io
description: 'Operations tagged Subscriptions 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: Subscriptions Support
paths:
/support/workspaces/{workspace_id}/sms:
get:
tags:
- Subscriptions Support
summary: Get subscription details
description: Retrieve associated chargebee subscription details for the workspace
operationId: GetSubscriptionDetail
parameters:
- name: workspace_id
in: path
schema:
type: integer
minimum: 0.0
title: Workspace ID
description: Id of the workspace to work with
examples:
- 4
description: Id of the workspace to work with
required: true
deprecated: false
examples:
workspace_id-example-1:
summary: Sample workspace ID
value: 4
- name: fields
in: query
schema:
type: string
title: Fields
description: Fields to return. Can be (id, name)
default: __standard
examples:
- id,name
description: Fields to return. Can be (id, name)
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
examples:
fields-example-1:
summary: Return only id and name in the result
value: id,name
responses:
'200':
description: List of workspaces
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionSchema'
'400':
description: Bad Request
'401':
description: Authorization error
deprecated: false
post:
tags:
- Subscriptions Support
summary: Create subscription for workspace
description: Associate the workspace with chargebee subscription
operationId: RegisterSubscription
parameters:
- name: workspace_id
in: path
schema:
type: integer
minimum: 0.0
title: Workspace ID
description: Id of the workspace to work with
examples:
- 4
description: Id of the workspace to work with
required: true
deprecated: false
examples:
workspace_id-example-1:
summary: Sample workspace ID
value: 4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerSchema'
required: true
responses:
'201':
description: Document created, URL follows
headers: {}
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/JobSchema'
- type: 'null'
'400':
description: Bad request syntax or unsupported method
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: Validation Exception
examples:
- status_code: 400
detail: Bad Request
extra: {}
deprecated: false
patch:
tags:
- Subscriptions Support
summary: Update subscription for workspace
description: Update the workspace's chargebee subscription
operationId: UpdateSubscription
parameters:
- name: workspace_id
in: path
schema:
type: integer
minimum: 0.0
title: Workspace ID
description: Id of the workspace to work with
examples:
- 4
description: Id of the workspace to work with
required: true
deprecated: false
examples:
workspace_id-example-1:
summary: Sample workspace ID
value: 4
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/support_schema_SubscriptionPatchRequest'
required: true
responses:
'200':
description: Request fulfilled, document follows
headers: {}
'400':
description: Bad request syntax or unsupported method
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: Validation Exception
examples:
- status_code: 400
detail: Bad Request
extra: {}
deprecated: false
servers:
- url: /api/v2
/support/sms:
get:
tags:
- Subscriptions Support
summary: Get available plans and other chargebee resources
description: Retrieve the list of available plans and other Chargebee-related resources
operationId: GetPlans
parameters:
- name: resource
in: query
schema:
type: string
title: Resource Type
description: Type of resource to list
default: plans
description: Type of resource to list
required: true
deprecated: false
allowEmptyValue: false
allowReserved: false
responses:
'200':
description: List of plans
content:
application/json:
schema:
$ref: '#/components/schemas/PlanList'
'400':
description: Bad Request
'401':
description: Authorization error
deprecated: false
servers:
- url: /api/v2
components:
schemas:
SubscriptionPatchOp:
properties:
op:
type: string
const: replace
description: Operation
examples:
- value: replace
path:
type: string
const: subscription_id
description: Path
examples:
- value: subscription_id
value:
type: string
description: Value to replace the attribute with
examples:
- value: SubscriptionId
type: object
required:
- op
- path
- value
title: SubscriptionPatchOp
support_schema_SubscriptionPatchRequest:
properties:
patch:
items:
$ref: '#/components/schemas/SubscriptionPatchOp'
type: array
type: object
required:
- patch
title: SubscriptionPatchRequest
description: Subscription detail which needs to be updated
examples:
- patch:
- op: replace
path: subscription_id
value: AleMockSubsIda32ax
JobSchema:
properties:
id:
type: integer
minimum: 0.0
title: Job id
examples:
- value:
id: 10
status:
type: string
enum:
- success
- failure
- processing
- error
title: Job status
description: Job status can be success, failure or processing
examples:
- value:
status: success
response:
oneOf:
- type: object
- type: array
description: Result of async task is stored in response
examples:
- value:
response:
object: some object
last_updated_at:
type: string
format: date-time
title: Job last updated at
description: Job last updated at is the time when Job status was last updated
examples:
- value:
last_updated_at: '2021-08-10T10:00:00'
created_at:
type: string
format: date-time
title: Job created at
description: Create at is time when async task was created
examples:
- value:
created_at: '2021-08-10T10:00:00'
path:
type: string
title: Job path
description: API request path of the Job operation
examples:
- value:
path: /api/v2/dataviews/1
operation:
type: string
title: Job operation
description: Operation is async task name which Job is tracking
examples:
- value:
operation: post_modification_pipeline_execution
type: object
required:
- created_at
- id
- last_updated_at
- operation
- path
- response
- status
title: JobSchema
SubscriptionSchema:
properties:
sms_details:
type: object
title: Subscription details
description: Subscription details
examples:
- summary: Sample Sms details
value: '{}'
url:
type: string
title: URL
description: URL of the subscription
examples:
- summary: Sample URL
value: test.chargebee.com/admin-console/customers/123456789
current_plan:
$ref: '#/components/schemas/CurrentPlanSchema'
available_plans:
items:
$ref: '#/components/schemas/CurrentPlanSchema'
type: array
available_addons:
items:
$ref: '#/components/schemas/CurrentPlanSchema'
type: array
type: object
required:
- available_addons
- available_plans
- current_plan
- sms_details
- url
title: SubscriptionSchema
CustomerSchema:
properties:
first_name:
oneOf:
- type: string
- type: 'null'
title: Customer's first name
description: First Name of the customer
examples:
- summary: First Name
value: John
last_name:
oneOf:
- type: string
- type: 'null'
title: Customer's last name
description: Last Name of the customer
examples:
- summary: Last Name
value: Adom
email:
oneOf:
- type: string
format: email
title: Email of the user
description: Email of the customer
examples:
- value: test@gmail.com
- type: 'null'
title: Email
description: Email of the customer
examples:
- summary: Email
value: example@some.com
company_name:
oneOf:
- type: string
- type: 'null'
title: Company
description: Company of the customer
examples:
- summary: Company
value: Bad
plan_id:
type: string
title: Chargebee Plan ID
description: Plan ID of the customer
examples:
- summary: Sample Plan ID
value: professional
customer_id:
oneOf:
- type: string
- type: 'null'
title: Customer ID
description: ID of the customer
examples:
- summary: Customer ID
value: cus_123456789
type: object
required:
- plan_id
title: CustomerSchema
description: Subscription creation details
examples:
- first_name: TestUser
last_name: TestUser
email: testuser@test.com
company_name: Test Company
plan_id: plan_1
- customer_id: mock_test_subs_id
plan_id: plan_1
PlanList:
properties:
available_plans:
items:
$ref: '#/components/schemas/PlansSchema'
type: array
type: object
required:
- available_plans
title: PlanList
CurrentPlanSchema:
properties:
id:
type: string
title: ID
description: ID of the SMS
examples:
- value: 2
plan_id:
type: string
title: Plan ID
description: Plan ID of the SMS
examples:
- value: internal
type: object
required:
- id
- plan_id
title: CurrentPlanSchema
PlansSchema:
properties:
id:
type: string
title: ID
description: ID of the plan
examples:
- value: internal
name:
type: string
title: Name
description: Name of the plan
examples:
- value: internal
type: object
required:
- id
- name
title: PlansSchema
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