Credit

Apply the coupon code for a service

post/credit/apply-coupon

Request

  • Base URL
    https://core.hivelocity.net/api/v2
  • URL
    https://core.hivelocity.net/api/v2/credit/apply-coupon
  • Auth
    API key in header X-API-KEY

Headers

X-Fieldsstring mask

An optional fields mask

Request body

codestring required

Coupon code

Response

Success

amountnumber

The amount of credit associated with the credit ID

autoApplyinteger

Whether credits are automatically being applied to new orders or invoices. [0 = Not Auto Apply, 1 = Auto Apply New Invoices, 2 = Auto Apply All Invoices]

balancenumber

The amount of credit available for use associated with the credit ID

billingInfoIdinteger

The Billing Info ID used to purchase the credits on this account

clientIdinteger

The client ID associated with the credit ID

createdinteger

The created date/time of the credit

expirationDateinteger

The expiration date of the credit

idinteger

The ID corresponding to a particular credit

isHourlyboolean

If credit is for hourly billing

orderIdinteger

The order ID associated with the credit ID

reasonstring

The reason code for the creation of the credit

serviceIdsinteger[]

The list of service IDs associated with the credit ID

statusstring

The status of the credit

Changes

No recorded changes to this operation across all 1 revision of this API.