Skapa bokföringspost

Skapar en bokföringspost för att kreditera eller debitera en kunds saldo

POST /credit-entitlements/{credit_entitlement_id}/balances/{customer_id}/ledger-entries

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 response = await client.creditEntitlements.balances.createLedgerEntry('customer_id', {
  credit_entitlement_id: 'credit_entitlement_id',
  amount: 'amount',
  entry_type: 'credit',
});

console.log(response.id);

201

{
  "amount": "<string>",
  "balance_after": "<string>",
  "balance_before": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "credit_entitlement_id": "<string>",
  "customer_id": "<string>",
  "id": "<string>",
  "is_credit": true,
  "overage_after": "<string>",
  "overage_before": "<string>",
  "grant_id": "<string>",
  "reason": "<string>"
}

Auktoriseringar

Authorization · string · header · obligatorisk

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

Sökvägsparametrar

credit_entitlement_id · string · obligatorisk

Credit Entitlement ID

customer_id · string · obligatorisk

Customer ID

Kropp

application/json

Request to create a ledger entry (credit or debit)

amount · string · obligatorisk

Amount to credit or debit

entry_type · enum<string> · obligatorisk

Entry type: credit or debit

Tillgängliga alternativ: credit, debit

expires_at · string<date-time> | null

Expiration for credited amount (only for credit type)

idempotency_key · string | null

Idempotency key to prevent duplicate entries

metadata · object

Optional metadata (max 50 key-value pairs, key max 40 chars, value max 500 chars)

Show child attributes

reason · string | null

Human-readable reason for the entry

Svar

201

application/json

Ledger entry created successfully

Response for creating a ledger entry

amount · string · obligatorisk

balance_after · string · obligatorisk

balance_before · string · obligatorisk

created_at · string<date-time> · obligatorisk

credit_entitlement_id · string · obligatorisk

customer_id · string · obligatorisk

entry_type · enum<string> · obligatorisk

Tillgängliga alternativ: credit, debit

id · string · obligatorisk

is_credit · boolean · obligatorisk

overage_after · string · obligatorisk

overage_before · string · obligatorisk

grant_id · string | null

reason · string | null