API reference / Stores

Store billing

1 operation.

GET/api/v1/stores/{storeId}/billing

Get the store’s billing

Store member

How seller fees are billed: the payment method on file, recent invoices and the fee rate.

SDK: collector.getStoreBilling()
Key scopes: store:billing:read(API keys are coming soon)
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`storeId`required	path	string (uuid)

Responses

200The billing summary.
StoreBillingSummary
How seller fees are billed: the payment method, recent invoices and the fee rate.
- configuredbooleanrequired
- billingReadybooleanrequired
- hasCustomerbooleanrequired
- paymentMethodobject or nullrequired
  Fields of paymentMethod
  brandstring or nullrequired
  last4string or nullrequired
  expMonthinteger or nullrequired
  expYearinteger or nullrequired
- invoicesarray of objectrequired
  Fields of invoices
  idstringrequired
  numberstring or nullrequired
  statusstring or nullrequired
  amountDueCentsintegerrequired
  amountPaidCentsintegerrequired
  currencystringrequired
  createdAtstring (date-time)required
  hostedInvoiceUrlstring (uri) or nullrequired
  periodLabelstring or nullrequired
- feeobjectrequired
  Fields of fee
  bpsintegerrequired
  Seller fee in basis points (100 = 1%).
  minFeeCentsintegerrequired
  maxFeeCentsinteger or nullrequired
  currencystringrequired
  storeOverridebooleanrequired
  This store has its own rate.
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (401, 403, 404, 500)

401unauthorized
unauthorized: Not signed in (no session or token, or an expired one).
403forbidden
forbidden: Only the store’s owners and admins can do this.
404not_found
not_found: Nothing at that address.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/stores/<storeId>/billing' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

TypeScript SDK

await collector.getStoreBilling({ path: { storeId } });