Billing

Billing wallet reads visible to the management token.

Get billing summary

GET

https://api.pokerworks.io

/api/v1/management/billing

Read billing wallet state visible to a management token

Get billing summary › Responses

BillingSummaryResponse

object[] · required

customer

object | null · required

organizationId

string · required

provider

string | null · enum · required

Enum values:

paddle

stripe

object[] · required

object · required

GET/api/v1/management/billing

curl https://api.pokerworks.io/api/v1/management/billing \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "balances": [
    {
      "balanceCredits": 0,
      "environment": "test"
    }
  ],
  "creditPacks": [
    {
      "checkoutEnabled": true,
      "credits": 1,
      "currency": "currency",
      "description": "description",
      "label": "label",
      "packageKey": "packageKey",
      "priceCents": 1,
      "provider": "paddle",
      "providerPriceId": "providerPriceId"
    }
  ],
  "customer": {
    "provider": "paddle",
    "providerCustomerId": "providerCustomerId"
  },
  "organizationId": "organizationId",
  "provider": "paddle",
  "receipts": [
    {
      "amountCents": 0,
      "creditedAt": "2024-08-25T15:00:00Z",
      "credits": 0.1,
      "currency": "currency",
      "environment": "test",
      "packageKey": "packageKey",
      "provider": "paddle",
      "providerTransactionId": "providerTransactionId",
      "status": "draft"
    }
  ],
  "settings": {
    "autoRecharge": {
      "enabled": true,
      "packageKey": "packageKey",
      "thresholdCredits": 0
    }
  }
}

json

application/json

Usage Audit

PokerWorks Management API

Billing

Billing wallet reads visible to the management token.

Get billing summary

GET

https://api.pokerworks.io

/api/v1/management/billing

Read billing wallet state visible to a management token

Get billing summary › Responses

BillingSummaryResponse

object[] · required

customer

object | null · required

organizationId

string · required

provider

string | null · enum · required

Enum values:

paddle

stripe

object[] · required

object · required

GET/api/v1/management/billing

curl https://api.pokerworks.io/api/v1/management/billing \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "balances": [
    {
      "balanceCredits": 0,
      "environment": "test"
    }
  ],
  "creditPacks": [
    {
      "checkoutEnabled": true,
      "credits": 1,
      "currency": "currency",
      "description": "description",
      "label": "label",
      "packageKey": "packageKey",
      "priceCents": 1,
      "provider": "paddle",
      "providerPriceId": "providerPriceId"
    }
  ],
  "customer": {
    "provider": "paddle",
    "providerCustomerId": "providerCustomerId"
  },
  "organizationId": "organizationId",
  "provider": "paddle",
  "receipts": [
    {
      "amountCents": 0,
      "creditedAt": "2024-08-25T15:00:00Z",
      "credits": 0.1,
      "currency": "currency",
      "environment": "test",
      "packageKey": "packageKey",
      "provider": "paddle",
      "providerTransactionId": "providerTransactionId",
      "status": "draft"
    }
  ],
  "settings": {
    "autoRecharge": {
      "enabled": true,
      "packageKey": "packageKey",
      "thresholdCredits": 0
    }
  }
}

json

application/json

Usage Audit