Subscription

GET/api/app/subscription

Query parameters

Response

200400401403404500501

Success

Body

text/plainapplication/jsontext/json

itemsnullable array of Snam.Platform.Subscriptions.Dtos.SubscriptionDto (object)

totalCountinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('/api/app/subscription', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500501

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "2024-11-27T19:37:44.697Z",
      "creatorId": "123e4567-e89b-12d3-a456-426614174000",
      "lastModificationTime": "2024-11-27T19:37:44.697Z",
      "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
      "isDeleted": false,
      "deleterId": "123e4567-e89b-12d3-a456-426614174000",
      "deletionTime": "2024-11-27T19:37:44.697Z",
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "customerName": "text",
      "startAt": "2024-11-27T19:37:44.697Z",
      "nextBillingAt": "2024-11-27T19:37:44.697Z",
      "name": "text",
      "status": 1,
      "statusString": "text",
      "discount": 0,
      "code": "text",
      "items": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "quantity": 0,
          "isUsageBased": false,
          "usageType": 1,
          "priceItems": [
            {
              "toQuantity": 0,
              "fromQuantity": 0,
              "amount": 0
            }
          ]
        }
      ]
    }
  ]
}

POST/api/app/subscription

Body

application/jsontext/jsonapplication/*+json

customerIdstring (uuid)

startAtstring (date-time)

discountnumber (double)

branchIdstring (uuid)

itemsnullable array of Snam.Platform.Subscriptions.Dtos.CreateUpdateSubscriptionItemDto (object)

Response

200400401403404500501

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/app/subscription', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404500501

{
  "error": {
    "code": "text",
    "message": "text",
    "details": "text",
    "validationErrors": [
      {
        "message": "text",
        "members": [
          "text"
        ]
      }
    ]
  }
}

GET/api/app/subscription/{id}

Path parameters

id*string (uuid)

Response

200400401403404500501

Success

Body

text/plainapplication/jsontext/json

idstring (uuid)

creationTimestring (date-time)

creatorIdnullable string (uuid)

lastModificationTimenullable string (date-time)

lastModifierIdnullable string (uuid)

isDeletedboolean

deleterIdnullable string (uuid)

deletionTimenullable string (date-time)

customerIdstring (uuid)

customerNamenullable string

startAtstring (date-time)

nextBillingAtstring (date-time)

namenullable string

statusSnam.Platform.Subscriptions.SubscriptionStatus (enum)

123456

statusStringnullable string

daysinteger (int32)

discountnumber (double)

codenullable string

itemsnullable array of Snam.Platform.Subscriptions.Dtos.SubscriptionItemDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/app/subscription/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500501

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "creationTime": "2024-11-27T19:37:44.697Z",
  "creatorId": "123e4567-e89b-12d3-a456-426614174000",
  "lastModificationTime": "2024-11-27T19:37:44.697Z",
  "lastModifierId": "123e4567-e89b-12d3-a456-426614174000",
  "isDeleted": false,
  "deleterId": "123e4567-e89b-12d3-a456-426614174000",
  "deletionTime": "2024-11-27T19:37:44.697Z",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerName": "text",
  "startAt": "2024-11-27T19:37:44.697Z",
  "nextBillingAt": "2024-11-27T19:37:44.697Z",
  "name": "text",
  "status": 1,
  "statusString": "text",
  "discount": 0,
  "code": "text",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "quantity": 0,
      "isUsageBased": false,
      "usageType": 1,
      "priceItems": [
        {
          "toQuantity": 0,
          "fromQuantity": 0,
          "amount": 0
        }
      ]
    }
  ]
}

DELETE/api/app/subscription/{id}

Path parameters

id*string (uuid)

Response

200400401403404500501

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/app/subscription/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404500501

{
  "error": {
    "code": "text",
    "message": "text",
    "details": "text",
    "validationErrors": [
      {
        "message": "text",
        "members": [
          "text"
        ]
      }
    ]
  }
}