credits

Grant billing credits to company

Changed on
post/billing/credits/grants/company

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/billing/credits/grants/company
  • Auth
    API key in header X-Schematic-Api-Key

Request body

billing_periods_countinteger nullable
company_idstring required
credit_bundle_idstring nullable
credit_idstring required
currency'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'ars' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'fkp' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'std' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmw'
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' | 'postpaid_forgiven' | 'postpaid_overdraft' | 'postpaid_settlement' | 'purchased' | 'rollover' required
renewal_enabledboolean nullable
renewal_period'billing_period' | 'first_of_month'

Response

Created

paramsobject required

Input parameters

Changes

  • b5afdab895bdRevision changes
    • warning

      added the new postpaid_forgiven enum value to the / response property for the response status

    • warning

      added the new postpaid_settlement enum value to the / response property for the response status

    • info

      added the new postpaid_forgiven enum value to the request property

    • info

      added the new postpaid_settlement enum value to the request property

  • afe97b9908caRevision changes
    • warning

      added the new postpaid_overdraft enum value to the / response property for the response status

    • info

      added the new postpaid_overdraft enum value to the request property