Subscription

get

/api/app/subscription

Query parameters

CustomerIdstring · uuid

PackageIdstring · uuid

Statusinteger · enum

Options: 1, 2, 3, 4, 5, 6

Sortingstring

SkipCountinteger · int32 · max: 2147483647

MaxResultCountinteger · int32 · min: 1 · max: 2147483647

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/app/subscription'

200

400

401

403

404

500

501

200

text/plain

application/json

text/json

text/plain

{
  "totalCount": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "2025-02-20T19:01:35.066Z",
      "creatorId": "123e4567-e89b-12d3-a456-426614174000",
      "lastModificationTime": "2025-02-20T19:01:35.066Z",
      "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
      "isDeleted": true,
      "deleterId": "123e4567-e89b-12d3-a456-426614174000",
      "deletionTime": "2025-02-20T19:01:35.066Z",
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "customerName": "text",
      "startAt": "2025-02-20T19:01:35.066Z",
      "nextBillingAt": "2025-02-20T19:01:35.066Z",
      "name": "text",
      "status": 1,
      "statusString": "text",
      "days": 1,
      "discount": 1,
      "code": "text",
      "items": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "quantity": 1,
          "isUsageBased": true,
          "usageType": 1,
          "priceItems": [
            {
              "toQuantity": 1,
              "fromQuantity": 1,
              "amount": 1
            }
          ]
        }
      ]
    }
  ]
}

Success

post

/api/app/subscription

Body

application/jsontext/jsonapplication/*+json

customerIdstring · uuid

startAtstring · date-time

discountnumber · double

branchIdstring · uuid

itemsobject[] | nullable

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

500

501

200

No body

Success

get

/api/app/subscription/{id}

Path parameters

idstring · uuidrequired

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

500

501

200

text/plain

application/json

text/json

text/plain

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "2025-02-20T19:01:35.066Z",
  "creatorId": "123e4567-e89b-12d3-a456-426614174000",
  "lastModificationTime": "2025-02-20T19:01:35.066Z",
  "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
  "isDeleted": true,
  "deleterId": "123e4567-e89b-12d3-a456-426614174000",
  "deletionTime": "2025-02-20T19:01:35.066Z",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerName": "text",
  "startAt": "2025-02-20T19:01:35.066Z",
  "nextBillingAt": "2025-02-20T19:01:35.066Z",
  "name": "text",
  "status": 1,
  "statusString": "text",
  "days": 1,
  "discount": 1,
  "code": "text",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "quantity": 1,
      "isUsageBased": true,
      "usageType": 1,
      "priceItems": [
        {
          "toQuantity": 1,
          "fromQuantity": 1,
          "amount": 1
        }
      ]
    }
  ]
}

Success

delete

/api/app/subscription/{id}

Path parameters

idstring · uuidrequired

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

500

501

200

No body

Success