Skip to main content
POST

Authorizations

x-api-key
string
header
required

Body

application/json

Execute a charge for a consumer offer bill.

requestId
string
required

Bango-generated Request ID (UUID v4). Should be returned in the API response.This allows correalating individual requests and responses.

billEffectiveDate
string
required

Date the bill was generated for.

billType
enum<string>
required

Bill type:

  • FIRST_BILL: First bill for this consumer offer
  • RENEWAL: Renewal bill
  • PRO_RATED_CHARGE: Triggered on product or tier changes
Available options:
FIRST_BILL,
RENEWAL,
PRO_RATED_CHARGE
Example:

"RENEWAL"

billId
string
required

Bango-generated unique bill identifier (UUID v4).If the initial charge fails, all subsequent retries will have the same billId.

amount
integer
required

Charge amount, in minor units

currency
string
required

Currency code (ISO 4217)

resourceType
string
required

Type of resource that is being charged.

Allowed value: "CONSUMER_OFFER"
consumer
ConsumerWithBillingIdentifier · object
required

Consumer with billing identifier.

chargeId
string
required

Bango-generated unique identifier of the charge transaction (UUID v4). There could be more than one charge per bill.

Example:

"c699aa49-35ea-4a23-9c3e-4479413db91d"

chargeAttempt
integer
required

Charge attempt. 0 if it's the first attempt, 1 for the first retry...

Example:

0

isRetry
boolean
required

Whether this is a retry of a charge

Example:

false

consumerOffer
Consumer Offer · object
required

Consumer offer details

billingDetails
Billing Details · object
required

Billing details

lineItems
(LineItemForOffer · object | LineItemForTierChangeProration · object | LineItemForEntitlementTierDelta · object)[]
required

List of line items

Line item details - offer base price.

externalRecurringChargeId
string

Partner-generated identifier of the authorization for recurring charges.

Response

OK

Charge approved response.

requestId
string
required

Bango-generated Request ID (UUID v4). Should be returned in the API response.This allows correalating individual requests and responses.

responseCode
string
required

Result of the operation

Allowed value: "APPROVED"
partnerChargeId
string

Unique identifier of the charge operation, generated by reseller.