Skip to main content
POST
billing.transaction.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
transactionId
string
required

Charge ID from billing.transactions.list.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

The result

transactionId
string
required

The charge's id. Pass it to billing.refund.create to refund it.

status
enum<string>
required

Charge state.

Available options:
pending,
paid,
past_due,
failed,
canceled,
unknown
total
object
required

Total charged to the customer, tax included.

customerId
string

The customer charged.

subscriptionId
string

The subscription it belongs to, if any.

createdAt
string

When the charge was created, ISO 8601.

billedAt
string

When it was billed, ISO 8601.