Tạo mục sổ cái

Tạo một mục sổ cái để ghi có hoặc ghi nợ số dư của khách hàng

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>"
}

Ủy quyền

Authorization · string · header · bắt buộc

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

Tham số đường dẫn

credit_entitlement_id · string · bắt buộc

Credit Entitlement ID

customer_id · string · bắt buộc

Customer ID

Nội dung

application/json

Request to create a ledger entry (credit or debit)

amount · string · bắt buộc

Amount to credit or debit

entry_type · enum<string> · bắt buộc

Entry type: credit or debit

Tùy chọn có sẵn: 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

Phản hồi

201

application/json

Ledger entry created successfully

Response for creating a ledger entry

amount · string · bắt buộc

balance_after · string · bắt buộc

balance_before · string · bắt buộc

created_at · string<date-time> · bắt buộc

credit_entitlement_id · string · bắt buộc

customer_id · string · bắt buộc

entry_type · enum<string> · bắt buộc

Tùy chọn có sẵn: credit, debit

id · string · bắt buộc

is_credit · boolean · bắt buộc

overage_after · string · bắt buộc

overage_before · string · bắt buộc

grant_id · string | null

reason · string | null