Skip to main content
POST
billing.variant.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
variantId
string
required

Variant ID from billing.variants.list.

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

Response

The result

variantId
string
required

Your catalog variant ID.

productId
string
required

Parent product ID.

name
string
required

Variant name.

status
enum<string>
required

Publication state; pending may be a default variant.

Available options:
pending,
draft,
published,
unknown
description
string

Plain text description.

hasLicenseKeys
boolean

Purchases issue license credentials.

activationLimit
number

Maximum activations when limited.

unlimitedActivations
boolean

No activation limit.

licenseLength
number

License duration count.

licenseLengthUnit
enum<string>

License duration unit.

Available options:
days,
months,
years
perpetualLicense
boolean

No fixed expiration.

sort
number

Checkout display order.

createdAt
string

Creation time, ISO 8601.

updatedAt
string

Last update, ISO 8601.