Zuwendungen auflisten

Alle Zuwendungen für eine Berechtigung auflisten, mit optionalen Filtern nach Status und Kunden-ID. Jede Zuwendung enthält den Erfüllungsstatus pro Kunde, einschließlich Lizenzschlüsseln und URLs zum Herunterladen digitaler Dateien, wo zutreffend.

GET /entitlements/{id}/grants

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
});

// Automatically fetches more pages as needed.
for await (const entitlementGrant of client.entitlements.grants.list('id')) {
  console.log(entitlementGrant.id);
}

200

{
  "items": [
    {
      "business_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "entitlement_id": "<string>",
      "id": "<string>",
      "metadata": {},
      "updated_at": "2023-11-07T05:31:56Z",
      "delivered_at": "2023-11-07T05:31:56Z",
      "digital_product_delivery": {
        "files": [
          {
            "download_url": "<string>",
            "expires_in": 123,
            "file_id": "<string>",
            "filename": "<string>",
            "content_type": "<string>",
            "file_size": 123
          }
        ],
        "external_url": "<string>",
        "instructions": "<string>"
      },
      "error_code": "<string>",
      "error_message": "<string>",
      "license_key": {
        "activations_used": 123,
        "key": "<string>",
        "activations_limit": 123,
        "expires_at": "2023-11-07T05:31:56Z"
      },
      "oauth_expires_at": "2023-11-07T05:31:56Z",
      "oauth_url": "<string>",
      "payment_id": "<string>",
      "revocation_reason": "<string>",
      "revoked_at": "2023-11-07T05:31:56Z",
      "subscription_id": "<string>"
    }
  ]
}

Autorisierungen

Authorization · string · header · erforderlich

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

Pfadparameter

id · string · erforderlich

Entitlement ID

Abfrageparameter

page_size · integer<int32>

Page size (default 10, max 100)

Erforderlicher Bereich: x >= 0

page_number · integer<int32>

Page number (default 0)

Erforderlicher Bereich: x >= 0

status · enum<string>

Filter by grant status

Verfügbare Optionen: Pending, Delivered, Failed, Revoked

integration_type · enum<string>

Filter by integration type

Verfügbare Optionen: discord, telegram, github, figma, framer, notion, digital_files, license_key

customer_id · string

Filter by customer ID

Antwort

200

application/json

items · object[] · erforderlich

Show child attributes