v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Incluir uso

Este recursso permite incluir um usage de um items associado a uma subscription.

post/subscriptions/{subscription_id}/items/{item_id}/usages

Path parameters

subscription_idstring required

Código da assinatura.<br>Formato: sub_XXXXXXXXXXXXXXXX.

item_idstring required

Código do item da assinatura.<br>Formato: si_XXXXXXXXXXXXXXXX.

Request body

quantityinteger

Quantidade de usos a serem incluídos.

descriptionstring

Descrição do uso.

codestring

Código de identificação no sistema do cliente

groupstring

Código de identificação do grupo no sistema do cliente

Response

200

idstring

quantityinteger

statusstring

used_atstring

created_atstring

Example response

{
  "id": "usage_QV1gBLhalU35RNbx",
  "quantity": 1,
  "status": "active",
  "used_at": "2017-04-04T18:21:50Z",
  "created_at": "2017-04-04T18:21:50Z",
  "subscription_item": {
    "id": "si_EJ8lP61Cotbyz9jx",
    "description": "Bola",
    "quantity": 1,
    "status": "active",
    "created_at": "2017-04-04T18:21:18Z",
    "updated_at": "2017-04-04T18:21:18Z",
    "subscription": {
      "id": "sub_o0Jw4WYCMuPNqzGr",
      "code": "09NFPLBZY0",
      "start_at": "2017-04-04T00:00:00Z",
      "interval": "month",
      "interval_count": 1,
      "billing_type": "postpaid",
      "next_billing_at": "2017-05-04T00:00:00Z",
      "payment_method": "credit_card",
      "currency": "BRL",
      "statement_descriptor": "Spotify",
      "installments": 1,
      "status": "active",
      "created_at": "2017-04-04T18:21:17Z",
      "updated_at": "2017-04-04T18:21:17Z"
    }
  }
}