Obter direito de crédito

Recupera um direito de crédito específico pelo seu ID

GET /credit-entitlements/{id}

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const creditEntitlement = await client.creditEntitlements.retrieve('cde_ztxm5XJsKxWucRWA3rjdM');

console.log(creditEntitlement.id);

200

{
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "overage_behavior": "forgive_at_reset",
  "overage_enabled": true,
  "precision": 123,
  "rollover_enabled": true,
  "unit": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "currency": "AED",
  "description": "<string>",
  "expires_after_days": 123,
  "max_rollover_count": 123,
  "overage_limit": 123,
  "price_per_unit": "<string>",
  "rollover_percentage": 123,
  "rollover_timeframe_count": 123,
  "rollover_timeframe_interval": "Day"
}

Autorizações

Authorization · string · header · obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

id · string · obrigatório

Credit Entitlement ID

Parâmetros de consulta

locale · string

Shows the translated name, description and unit of the catalog entities in this locale. The value must be a code from GET /locales, for example fr. A field with no translation, an unknown code, or no code shows the base text.

Do not send a text from a localized response back in a create or update request. The base text then changes to the translated text.

Resposta

200

application/json

Credit entitlement details

business_id · string · obrigatório

created_at · string<date-time> · obrigatório

id · string · obrigatório

name · string · obrigatório

overage_behavior · enum<string> · obrigatório

Controls how overage is handled at billing cycle end.

Opções disponíveis: forgive_at_reset, invoice_at_billing, carry_deficit, carry_deficit_auto_repay

overage_enabled · boolean · obrigatório

precision · integer<int32> · obrigatório

rollover_enabled · boolean · obrigatório

unit · string · obrigatório

updated_at · string<date-time> · obrigatório

currency · null | enum<string>

Opções disponíveis: AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW

description · string | null

expires_after_days · integer<int32> | null

max_rollover_count · integer<int32> | null

overage_limit · integer<int64> | null

price_per_unit · string | null

Price per credit unit

rollover_percentage · integer<int32> | null

rollover_timeframe_count · integer<int32> | null

rollover_timeframe_interval · null | enum<string>

Unit of a duration count (e.g. license-key validity period).

Opções disponíveis: Day, Week, Month, Year