mammoth-io Subscription API

openapi: 3.2.0
info:
  title: Mammoth Io Subscription API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Subscription 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: Subscription
paths:
  /workspaces/{workspace_id}/subscription_v1/hosted-page:
    post:
      tags:
      - Subscription
      summary: Get hosted pages
      description: Get hosted pages of the subscription for the requested properties
      operationId: FetchHostedPage
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostedPageSchema'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
        '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: {}
        '200':
          description: Hosted page details
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/subscription_v1/invoices/{invoice_id}:
    get:
      tags:
      - Subscription
      summary: Get associated plan details
      description: Retrieve the current plan details for the workspace subscription
      operationId: GetInvoice
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: invoice_id
        in: path
        schema:
          type: integer
          exclusiveMinimum: 0.0
          title: Invoice ID
          description: ID of the invoice
          examples:
          - 4
        description: ID of the invoice
        required: true
        deprecated: false
        examples:
          invoice_id-example-1:
            summary: Sample invoice ID
            value: 4
      responses:
        '200':
          description: Invoice details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceSchema'
        '400':
          description: Bad Request
        '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: {}
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/subscription_v1:
    get:
      tags:
      - Subscription
      summary: Get subscription details
      description: Retrieve associated chargebee subscription details for the workspace
      operationId: GetWkspSubscriptionDetail
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        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: Workspace subscription details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMSResponseSchema'
        '400':
          description: Bad Request
        '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: {}
        '401':
          description: Authorization error
      deprecated: false
    patch:
      tags:
      - Subscription
      summary: Update subscription details
      description: Update associated chargebee subscription objects for the workspace
      operationId: UpdateSubscriptionDetail
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscriptions_schema_SubscriptionPatchRequest'
        required: true
      responses:
        '200':
          description: List of workspaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionsFieldSchema'
        '400':
          description: Bad Request
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/subscription_v1/invoices:
    get:
      tags:
      - Subscription
      summary: List all invoices
      description: List all invoices for the workspace subscription
      operationId: ListInvoices
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Limit
          description: Max number of result to return
          default: 50
          examples:
          - 10
        description: Max number of result to return
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          limit-example-1:
            summary: Limit returned result count to 10
            value: 10
      - name: sort
        in: query
        schema:
          type: string
          title: Sort Type
          description: 'Returns resource based on this parameter. Use the format ''(field:asc)'' for ascending and ''(field:desc)'' for descending order. Allowed values: date and updated_at'
          default: (date:desc)
          examples:
          - (date:desc)
        description: 'Returns resource based on this parameter. Use the format ''(field:asc)'' for ascending and ''(field:desc)'' for descending order. Allowed values: date and updated_at'
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          sort-example-1:
            summary: Order by invoice.date in descending order
            value: (date:desc)
      responses:
        '200':
          description: List of invoices
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoicesSchema'
        '400':
          description: Bad Request
        '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: {}
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    subscriptions_schema_SubscriptionPatchRequest:
      properties:
        patch:
          items:
            $ref: '#/components/schemas/SubscriptionPatchItem'
          type: array
      type: object
      required:
      - patch
      title: SubscriptionPatchRequest
      description: Details of the app to be created
      examples:
      - patch:
        - op: add
          path: addons
          value:
            type: storage
            count: 1
        - op: replace
          path: addons
          value:
            type: connector
            remove:
            - facebook_ads
            add:
            - ga_lib
        - op: add
          path: addons
          value:
            type: user
            count: 1
    InvoicesSchema:
      properties:
        invoices:
          items:
            oneOf:
            - type: object
            - type: 'null'
          type: array
          title: Invoices
          description: Invoices of the subscription
          examples:
          - summary: Sample Invoices
            value:
            - id: '123'
              name: Sample Invoice
      type: object
      required:
      - invoices
      title: InvoicesSchema
    HostedPageSchema:
      properties:
        object_type:
          type: string
          title: Page Type
          description: Type of the hosted page
          examples:
          - summary: Sample Page Type
            value: portal_session
        plan_id:
          oneOf:
          - type: string
          - type: 'null'
          title: Subscription plan ID
          description: ID of the plan
          examples:
          - summary: Sample Plan ID
            value: internal
      type: object
      required:
      - object_type
      title: HostedPageSchema
      description: Details of the hosted page
      examples:
      - object_type: change_plan
        plan_id: test_plan_11
    InvoiceSchema:
      properties:
        invoice:
          type: object
          title: Invoice Details
          description: Invoice Details
          examples:
          - summary: Sample Invoice Details
            value:
              id: '123'
              name: Sample Invoice
      type: object
      required:
      - invoice
      title: InvoiceSchema
    SubscriptionsFieldSchema:
      properties:
        subscription:
          oneOf:
          - type: object
          - type: 'null'
          title: Current subscription
          description: Current subscription details
          examples:
          - value:
              id: abc123
              name: Sample Subscription
        current_plan:
          oneOf:
          - type: object
          - type: 'null'
          title: Current Plan
          examples:
          - summary: Sample Current Plan
            value:
              id: internal
              name: Sample Plan
        available_plans:
          oneOf:
          - type: array
          - type: 'null'
          title: Available Plans
          description: Available Plans of the subscription
          examples:
          - summary: Sample Available Plans
            value:
            - id: internal
              name: Sample Plan
        available_addons:
          oneOf:
          - type: array
          - type: 'null'
          title: Available Addons
          description: Available Addons of the subscription
          examples:
          - summary: Sample Available Addons
            value:
            - id: additional-user
              name: Sample Addon
        workspace_addons:
          oneOf:
          - additionalProperties:
              items:
                type: object
              type: array
            type: object
          - type: 'null'
          title: Available Addons
          description: Available Addons of the subscription
          examples:
          - summary: Sample Available Addons
            value:
            - id: additional-user
              name: Sample Addon
      type: object
      required: []
      title: SubscriptionsFieldSchema
    SubscriptionPatchItem:
      properties:
        op:
          type: string
          enum:
          - add
          - remove
          - replace
          description: Operation to be performed on the subscription
          examples:
          - summary: Add
            value: add
        path:
          type: string
          const: addons
          description: Path of the subscription
          examples:
          - summary: Subscription
            value: addons
        value:
          $ref: '#/components/schemas/SubscriptionPatchValue'
      type: object
      required:
      - op
      - path
      - value
      title: SubscriptionPatchItem
    SMSResponseSchema:
      properties:
        current_plan_new:
          oneOf:
          - type: object
          - type: 'null'
          title: Current Plan
          examples:
          - summary: Sample Current Plan
            value:
              id: internal
              name: Sample Plan
        current_plan:
          oneOf:
          - type: object
          - type: 'null'
          title: Current Plan
          examples:
          - summary: Sample Current Plan
            value:
              id: internal
              name: Sample Plan
        sms_details:
          oneOf:
          - $ref: '#/components/schemas/SubscriptionsFieldSchema'
          - type: 'null'
          title: Current subscription
          description: Current subscription details
          examples:
          - value:
              id: abc123
              name: Sample Subscription
        next_action_info:
          oneOf:
          - type: object
          - type: 'null'
          title: Next Action Info
          description: BE-driven next action the FE should render for this workspace's subscription
          examples:
          - summary: Sample Next Action Info
            value:
              next_action: none
              is_trial_expired: false
              trial_days_remaining: 0
              payment_action_required: false
        over_limit_info:
          oneOf:
          - type: object
          - type: 'null'
          title: Over Limit Info
          description: Live over-limit report for this workspace's subscription
          examples:
          - summary: Sample Over Limit Info
            value:
              over_limit: false
              items: []
        seat_info:
          oneOf:
          - type: object
          - type: 'null'
          title: Seat Info
          description: 'Builder seats: builders (with pending builder invites), limit (with bought seats) and remaining; limit and remaining are null when there is no cap'
          examples:
          - summary: Sample Seat Info
            value:
              builders: 3
              limit: 5
              remaining: 2
        is_deal:
          oneOf:
          - type: boolean
          - type: 'null'
          title: Is Deal
          description: True when an active or trialing deal governs the workspace
        is_partner_billed:
          oneOf:
          - type: boolean
          - type: 'null'
          title: Is Partner Billed
          description: True when a partner is billed for the workspace
        open_invoice_url:
          oneOf:
          - type: string
          - type: 'null'
          title: Open Invoice URL
          description: Hosted page of the oldest open invoice of a direct deal workspace that is not active or trialing; null when there is none
        partner_name:
          oneOf:
          - type: string
          - type: 'null'
          title: Partner Name
          description: Name of the partner that bills a partner-billed workspace
      type: object
      required: []
      title: SMSResponseSchema
    SubscriptionPatchValue:
      properties:
        type:
          type: string
          enum:
          - storage
          - connector
          - user
          description: Unit of the subscription
          examples:
          - summary: Storage
            value: storage
        count:
          oneOf:
          - type: integer
            exclusiveMinimum: 0.0
          - type: 'null'
          description: Quantity of the subscription
          examples:
          - summary: '1'
            value: 1
        add:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Add connectors to the subscription
          examples:
          - summary: Google Ads
            value: '[''hubspot'']'
        remove:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Remove connectors from the subscription
          examples:
          - summary: Facebook Ads
            value: '[''facebook_ads'']'
      type: object
      required:
      - type
      title: SubscriptionPatchValue
  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