Ordergroove

Ordergroove Subscriptions API

Recurring subscription agreements.

GitHub OpenAPI
Business capability
Subscription Modification BC-4240.40

Operations 6

GET /subscriptions/ List subscriptions #
GET /subscriptions/{public_id}/ Retrieve a subscription #
PUT /subscriptions/{public_id}/ Update a subscription #
POST /subscriptions/{public_id}/cancel/ Cancel a subscription #
POST /subscriptions/{public_id}/reactivate/ Reactivate a subscription #
POST /subscriptions/{public_id}/change_frequency/ Change subscription frequency #

Documentation

📖
Documentation
https://developer.ordergroove.com/reference/start
📖
APIReference
https://developer.ordergroove.com/reference/subscriptions-list
📖
APIReference
https://developer.ordergroove.com/reference/customers-list
📖
APIReference
https://developer.ordergroove.com/reference/orders-list
📖
APIReference
https://developer.ordergroove.com/reference/items-list
📖
APIReference
https://developer.ordergroove.com/reference/products-list
📖
APIReference
https://developer.ordergroove.com/reference/offer-profile-list
📖
Documentation
https://developer.ordergroove.com/reference/webhooks-overview
📖
APIReference
https://developer.ordergroove.com/docs/configure-webhooks-via-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ordergroove/refs/heads/main/openapi/ordergroove-subscriptions-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/ordergroove/refs/heads/main/collections/ordergroove.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/ordergroove/refs/heads/main/collections/ordergroove.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ordergroove-subscriptions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API 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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ordergroove-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ordergroove REST Subscriptions API
  description: The Ordergroove REST API operates an enterprise subscription and relationship-commerce program on top of a merchant's eCommerce store.
  version: '1.0'
  contact:
    name: Ordergroove Developer
    url: https://developer.ordergroove.com
servers:
- url: https://restapi.ordergroove.com
  description: Production
- url: https://staging.restapi.ordergroove.com
  description: Staging
security:
- apiKeyAuth: []
tags:
- name: Subscriptions
  description: Recurring subscription agreements.
paths:
  /subscriptions/:
    get:
      operationId: listSubscriptions
      tags:
      - Subscriptions
      summary: List subscriptions
      description: Lists subscriptions, filterable by customer, product, shipping address, live status, and created/updated date ranges. Listing across more than one customer requires the Bulk Operations permission.
      parameters:
      - name: customer
        in: query
        schema:
          type: string
        description: Filter by customer ID (Application scope only).
      - name: product
        in: query
        schema:
          type: string
      - name: live
        in: query
        schema:
          type: boolean
      - name: created_start
        in: query
        schema:
          type: string
          format: date
      - name: created_end
        in: query
        schema:
          type: string
          format: date
      responses:
        '200':
          description: A paginated list of subscriptions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /subscriptions/{public_id}/:
    get:
      operationId: retrieveSubscription
      tags:
      - Subscriptions
      summary: Retrieve a subscription
      parameters:
      - $ref: '#/components/parameters/PublicId'
      responses:
        '200':
          description: A subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: updateSubscription
      tags:
      - Subscriptions
      summary: Update a subscription
      parameters:
      - $ref: '#/components/parameters/PublicId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subscription'
      responses:
        '200':
          description: The updated subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
  /subscriptions/{public_id}/cancel/:
    post:
      operationId: cancelSubscription
      tags:
      - Subscriptions
      summary: Cancel a subscription
      parameters:
      - $ref: '#/components/parameters/PublicId'
      responses:
        '200':
          description: The cancelled subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
  /subscriptions/{public_id}/reactivate/:
    post:
      operationId: reactivateSubscription
      tags:
      - Subscriptions
      summary: Reactivate a subscription
      parameters:
      - $ref: '#/components/parameters/PublicId'
      responses:
        '200':
          description: The reactivated subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
  /subscriptions/{public_id}/change_frequency/:
    post:
      operationId: changeSubscriptionFrequency
      tags:
      - Subscriptions
      summary: Change subscription frequency
      parameters:
      - $ref: '#/components/parameters/PublicId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                every:
                  type: integer
                every_period:
                  type: string
                  enum:
                  - day
                  - week
                  - month
                  - year
      responses:
        '200':
          description: The updated subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
components:
  responses:
    TooManyRequests:
      description: Rate limit exceeded (more than 6000 requests per IP per minute). Safe to retry.
    Unauthorized:
      description: Authentication failed or the API key is missing or invalid.
  schemas:
    SubscriptionList:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
        next:
          type:
          - string
          - 'null'
        previous:
          type:
          - string
          - 'null'
    Subscription:
      type: object
      properties:
        id:
          type: string
        public_id:
          type: string
        customer_id:
          type: string
        product_id:
          type: string
        quantity:
          type: integer
        payment_id:
          type: string
        shipping_address_id:
          type: string
        offer_id:
          type: string
        every:
          type: integer
        every_period:
          type: string
          enum:
          - day
          - week
          - month
          - year
        live:
          type: boolean
  parameters:
    PublicId:
      name: public_id
      in: path
      required: true
      schema:
        type: string
      description: The public identifier of the resource.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Application API scope. Send one of the ten store API keys in the x-api-key header for server-to-server requests. Storefront requests use an HMAC-SHA256 signature scoped to a single customer instead (out of band of this scheme).