ActiveCampaign Credits API

The Credits API from ActiveCampaign — 1 operation(s) for credits.

Documentation GitHub OpenAPI

Documentation

https://developers.activecampaign.com/reference/overview

https://developers.activecampaign.com/reference/authentication

Specifications

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/openapi/activecampaign-credits-api-openapi.yml

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/asyncapi/activecampaign-webhooks-asyncapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-message-schema.json

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-create-request-schema.json

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-update-request-schema.json

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-metrics-schema.json

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-recipient-schema.json

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-credits-response-schema.json

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-ai-broadcast-request-schema.json

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-structure/activecampaign-sms-broadcast-message-structure.json

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-structure/activecampaign-sms-recipient-structure.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/graphql/activecampaign-graphql.md

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/examples/activecampaign-sms-broadcast-message-example.json

https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/examples/activecampaign-sms-recipient-example.json

OpenAPI Specification

openapi: 3.0.3
info:
  title: ActiveCampaign SMS Broadcast Accounts Credits API
  description: API for managing SMS broadcasts, lists, metrics, and AI-powered content generation in ActiveCampaign
  version: 3.0.0
  contact:
    name: ActiveCampaign Support
    url: https://www.activecampaign.com
  x-generated-from: documentation
servers:
- url: https://{yourAccountName}.api-us1.com/api/3
  description: US-based Users
  variables:
    yourAccountName:
      default: yourAccountName
security:
- ApiToken: []
tags:
- name: Credits
paths:
  /sms/credits:
    get:
      tags:
      - Credits
      summary: ActiveCampaign Get Current Sms Credit Use Data
      description: Retrieve the current period's sms credit usage and remaining balance
      operationId: getSmsCreditData
      responses:
        '200':
          description: Sms Credits for this period
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditsResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CreditsResponse:
      type: object
      properties:
        smsCredits:
          type: object
          properties:
            period:
              type: string
              example: month
            nextRefillDate:
              type: string
              example: '2026-02-26 15:06:25'
            includedThisPeriod:
              type: integer
              example: 1000
            usedThisPeriod:
              type: integer
              example: 71
            extra:
              type: integer
              example: 9040
            available:
              type: integer
              example: 9969
  securitySchemes:
    ApiToken:
      type: apiKey
      name: Api-Token
      in: header
      description: Your ActiveCampaign API token