Promotional credits

These credits can be provided to the customer for promoting the product. You can use Promotional Credits to offer referral bonuses, cash back offers and more. When a customer has promotional credits, it is automatically applied whenever a new invoice is created.

Sample Promotional creditJSON

Promotional credits attributes

required, string, max chars=150

Unique reference ID provided for promotional credits

customer_id

required, string, max chars=50

Identifier of the customer.

type

required, enumerated string

Type of promotional credits

Enum Values

increment

Increment

decrement

Decrement

amount_in_decimal

optional, string, max chars=33

Amount in decimal

amount

required, in cents, min=0

Promotional credits amount

currency_code

required, string, max chars=3

The currency code (ISO 4217 format) for promotional credit

description

required, string, max chars=250

Detailed description of this promotional credits.

credit_type

required, enumerated string, default=general

Type of promotional credits provided to customer

Enum Values

loyalty_credits

Loyalty Credits

referral_rewards

Referral

general

General

reference

optional, string, max chars=500

Describes why promotional credits were provided

closing_balance

required, in cents, min=0

Closing balance as on end date.

done_by

optional, string, max chars=100

The user who added/deducted the credit. If created via API, this contains the name given for the API key used.

created_at

required, timestamp(UTC) in seconds

Timestamp indicating when this promotional credit resource is created.

business_entity_id

optional, string, max chars=50

The unique identifier of the business entity associated with this promotional credit.