Skip to main content
GET
/
v1
/
c
/
entitlement
/
{customer_id}
/
billing
cURL
curl --request GET \
  --url http://127.0.0.1:8080/v1/c/entitlement/{customer_id}/billing \
  --header 'wb-key: <api-key>'
{
  "contract": {
    "contract_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
    "status": "active"
  },
  "customer": {
    "status": "active"
  },
  "payment": {
    "payment_provider": "stripe",
    "unpaid_invoices_info": [
      {
        "currency": "usd",
        "payment_threshold": "<string>",
        "total_unpaid": "<string>",
        "unpaid_invoices": [
          {
            "amount": "<string>",
            "due_date": "2023-11-07T05:31:56Z",
            "id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
            "status": "pending_validation"
          }
        ]
      }
    ],
    "wallet_balance": "<string>",
    "wallet_balances": [
      {
        "balance": "<string>",
        "currency": "usd",
        "customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
        "id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
        "wb_customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
      }
    ],
    "next_payment_due": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
wb-key
string
header
required

Path Parameters

​
customer_id
string
required

Id of the customer

Query Parameters

​
due_date_before
string<date> | null

Response

200 - application/json

Billing information for current cycle

Data to show the billing status of the customer (last payment date, wallet balance, etc)

​
contract
object
required

Describes Contract object for Entitlement endpoint

​
customer
object
required

Describes the status of the customer for Entitlement response

​
payment
object
required

Information about payment status displayed in the Entitlement API