credits

Grant billing credits to company

post/billing/credits/grants/company

Request body

billing_periods_countinteger nullable
company_idstring required
credit_idstring required
currencystring nullable
expires_atstring date-time nullable
expiry_type'duration' | 'end_of_billing_period' | 'end_of_next_billing_period' | 'end_of_trial' | 'no_expiry'
expiry_unit'billing_periods' | 'days'
expiry_unit_countinteger nullable
quantityinteger required
reason'adjustment' | 'billing_credit_auto_topup' | 'free' | 'plan' | 'purchased' | 'rollover' required
renewal_enabledboolean nullable
renewal_period'billing_period' | 'first_of_month'

Response

Created

paramsobject required

Input parameters

Changes

Changed in 9 of the 140 revisions of this API.186

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the new license_retired enum value to the ///// response property for the response status

      response-property-enum-value-added

    • added the new every_6_months enum value to the ///// response property for the response status

      response-property-enum-value-added

    • added the new quarterly enum value to the ///// response property for the response status

      response-property-enum-value-added

    • added the new customer_archived enum value to the ///// response property for the response status

      response-property-enum-value-added

    • added the new integration_uninstalled enum value to the ///// response property for the response status

      response-property-enum-value-added

    • the / response's property type changed from integer to number, and format from int64 to double for status

      response-property-type-changed

    • added the new reconciled enum value to the ///// response property for the response status

      response-property-enum-value-added

    • added the new metronome enum value to the // response property for the response status

      response-property-enum-value-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the new rollover enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new rollover enum value to the request property

      request-property-enum-value-added

    • added the optional property / to the response with the status

      response-optional-property-added