Usage

Last updated 10 months ago

get

/api/app/subscription/{id}/usage

Path parameters

idstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/app/subscription/{id}/usage'

200

400

401

403

404

500

501

text/plain

application/json

text/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "subscriptionItemId": "123e4567-e89b-12d3-a456-426614174000",
  "subscriptionItemName": "text",
  "usedAt": "2025-02-20T19:11:19.032Z",
  "recordedAt": "2025-02-20T19:11:19.032Z",
  "endedAt": "2025-02-20T19:11:19.032Z",
  "endRecordedAt": "2025-02-20T19:11:19.032Z",
  "externalReference": "text",
  "quantity": 1,
  "comments": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Success

put

/api/app/subscription/{id}/usage

Path parameters

idstring · uuidrequired

Body

subscriptionItemIdstring · uuid

usedAtstring · date-time

recordedAtstring · date-time

endedAtstring · date-time | nullable

endRecordedAtstring · date-time | nullable

externalReferencestring | nullable

quantitynumber · double

commentsstring | nullable

metadataobject | nullable

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/app/subscription/{id}/usage' \
  --header 'Content-Type: application/json' \
  --data '{"metadata":{}}'

200

400

401

403

404

500

501

No body

Success

post

/api/app/subscription/usage

Body

subscriptionItemIdstring · uuid

usedAtstring · date-time

recordedAtstring · date-time

endedAtstring · date-time | nullable

endRecordedAtstring · date-time | nullable

externalReferencestring | nullable

quantitynumber · double

commentsstring | nullable

metadataobject | nullable

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/app/subscription/usage' \
  --header 'Content-Type: application/json' \
  --data '{"metadata":{}}'

200

400

401

403

404

500

501

No body

Success