Get Subscription

Get one subscription in an agreement.

get

Path parameters

idstringRequired

Query parameters

selectstringOptional

Responses

200

OK

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /public/v1/commerce/subscriptions/{id} HTTP/1.1
Host: api.s1.today
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-08-29T17:28:18.433Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-08-29T17:28:18.433Z",
      "by": "[Circular Reference]"
    },
    "active": {
      "at": "2025-08-29T17:28:18.433Z",
      "by": "[Circular Reference]"
    },
    "terminated": {
      "at": "2025-08-29T17:28:18.433Z",
      "by": "[Circular Reference]"
    },
    "terminating": {
      "at": "2025-08-29T17:28:18.433Z",
      "by": "[Circular Reference]"
    },
    "updating": {
      "at": "2025-08-29T17:28:18.433Z",
      "by": "[Circular Reference]"
    },
    "expired": {
      "at": "2025-08-29T17:28:18.433Z",
      "by": "[Circular Reference]"
    },
    "renewed": {
      "at": "2025-08-29T17:28:18.433Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "startDate": "2025-08-29T17:28:18.433Z",
  "terminationDate": "2025-08-29T17:28:18.433Z",
  "externalIds": {
    "client": "text",
    "operations": "text",
    "vendor": "text"
  },
  "terms": {
    "period": "1m",
    "commitment": "1m"
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "autoRenew": true,
  "status": "Active",
  "commitmentDate": "2025-08-29T17:28:18.433Z",
  "price": {
    "currency": "text",
    "markup": 1,
    "margin": 1,
    "SPxY": 1,
    "SPxM": 1,
    "PPxY": 1,
    "PPxM": 1,
    "defaultMarkup": 1,
    "defaultMargin": 1
  },
  "parameters": {
    "fulfillment": [
      {
        "id": "text",
        "externalId": "text",
        "name": "text",
        "type": "SingleLineText",
        "phase": "Configuration",
        "error": {
          "id": "text",
          "message": "text",
          "parameters": null
        },
        "constraints": {
          "required": true,
          "hidden": true,
          "readonly": true
        },
        "displayValue": "text",
        "value": null
      }
    ]
  },
  "agreement": {
    "id": "text",
    "icon": "text",
    "status": "New",
    "name": "text"
  },
  "buyer": {
    "id": "text",
    "icon": "text",
    "name": "text"
  },
  "licensee": {
    "id": "text",
    "icon": "text",
    "name": "text",
    "externalId": "text"
  },
  "seller": {
    "id": "text",
    "icon": "text",
    "externalId": "text",
    "name": "text"
  },
  "split": {
    "id": "text"
  },
  "splitStatus": "Disabled",
  "lines": [
    {
      "id": "text",
      "quantity": 1,
      "item": {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "description": "text",
        "externalIds": {
          "vendor": "text",
          "operations": "text"
        },
        "group": {
          "id": "text",
          "name": "text"
        },
        "unit": {
          "id": "text",
          "description": "text",
          "name": "text"
        },
        "terms": {
          "period": "1m",
          "commitment": "1m"
        },
        "quantityNotApplicable": true,
        "status": "text",
        "product": {
          "id": "text",
          "name": "text",
          "externalIds": {
            "operations": "text",
            "defaultErpItem": "text"
          },
          "icon": "text",
          "status": "text"
        },
        "parameters": [
          {
            "id": "text",
            "externalId": "text",
            "type": "text",
            "name": "text",
            "value": null,
            "displayValue": "text"
          }
        ]
      },
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]",
        "terminated": "[Circular Reference]",
        "deleted": "[Circular Reference]"
      },
      "price": {
        "currency": "text",
        "markup": 1,
        "margin": 1,
        "unitSP": 1,
        "unitPP": 1,
        "SPxY": 1,
        "SPxM": 1,
        "PPxY": 1,
        "PPxM": 1
      },
      "subscription": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-08-29T17:28:18.433Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-08-29T17:28:18.433Z",
            "by": "[Circular Reference]"
          },
          "active": {
            "at": "2025-08-29T17:28:18.433Z",
            "by": "[Circular Reference]"
          },
          "terminated": {
            "at": "2025-08-29T17:28:18.433Z",
            "by": "[Circular Reference]"
          },
          "terminating": {
            "at": "2025-08-29T17:28:18.433Z",
            "by": "[Circular Reference]"
          },
          "updating": {
            "at": "2025-08-29T17:28:18.433Z",
            "by": "[Circular Reference]"
          },
          "expired": {
            "at": "2025-08-29T17:28:18.433Z",
            "by": "[Circular Reference]"
          },
          "renewed": {
            "at": "2025-08-29T17:28:18.433Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "startDate": "2025-08-29T17:28:18.433Z",
        "terminationDate": "2025-08-29T17:28:18.433Z",
        "externalIds": {
          "client": "text",
          "operations": "text",
          "vendor": "text"
        },
        "terms": {
          "period": "1m",
          "commitment": "1m"
        },
        "product": {
          "id": "text",
          "name": "text",
          "externalIds": {
            "operations": "text",
            "defaultErpItem": "text"
          },
          "icon": "text",
          "status": "text"
        },
        "autoRenew": true,
        "status": "Active",
        "commitmentDate": "2025-08-29T17:28:18.433Z",
        "price": {
          "currency": "text",
          "markup": 1,
          "margin": 1,
          "SPxY": 1,
          "SPxM": 1,
          "PPxY": 1,
          "PPxM": 1,
          "defaultMarkup": 1,
          "defaultMargin": 1
        },
        "parameters": {
          "fulfillment": [
            {
              "id": "text",
              "externalId": "text",
              "name": "text",
              "type": "SingleLineText",
              "phase": "Configuration",
              "error": {
                "id": "text",
                "message": "text",
                "parameters": null
              },
              "constraints": {
                "required": true,
                "hidden": true,
                "readonly": true
              },
              "displayValue": "text",
              "value": null
            }
          ]
        },
        "agreement": {
          "id": "text",
          "icon": "text",
          "status": "New",
          "name": "text"
        },
        "buyer": {
          "id": "text",
          "icon": "text",
          "name": "text"
        },
        "licensee": {
          "id": "text",
          "icon": "text",
          "name": "text",
          "externalId": "text"
        },
        "seller": {
          "id": "text",
          "icon": "text",
          "externalId": "text",
          "name": "text"
        },
        "split": {
          "id": "text"
        },
        "splitStatus": "Disabled",
        "lines": [
          "[Circular Reference]"
        ],
        "template": {
          "id": "text",
          "name": "text"
        }
      },
      "status": "Active"
    }
  ],
  "template": {
    "id": "text",
    "name": "text"
  }
}