SolutionsPricingDocsStart Free
Api

Get Delivery Settings

GET
/v1/programs/{programId}/delivery-settings

Read how a Program delivers Rewards: hold days and the method of each benefit kind. Needs the programs:read key permission.

Authorization

WorkspaceApiKey
X-Api-Key<token>

Workspace-owned Better Auth API key of one environment (Sandbox or Live); it authorizes the Projects of that environment in its Workspace. A Project of the other environment returns 403 ENVIRONMENT_MISMATCH. Never expose it in the browser.

In: header

Path Parameters

programId*string
Match\S
Length1 <= length <= 512

Query Parameters

projectId*string
Length1 <= length <= 128

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/programs/string/delivery-settings?projectId=string"
{  "success": true,  "data": {    "programId": "string",    "holdDays": 0,    "cashMethod": "operator",    "creditMethod": "operator",    "discountMethod": "operator",    "customMethod": "operator",    "planUpgrades": [      {        "unitKey": "string",        "plan": "string",        "periods": -9007199254740991      }    ],    "options": {      "cash": [        "operator"      ],      "credit": [        "operator"      ],      "discount": [        "operator"      ],      "custom": [        "operator"      ]    },    "updatedAt": "string"  }}