CreditLinePaymentMethod
Type: schema
Description
A payment method linked to the store credit line, as returned inside StoreConfig.credit_line. Read-only projection of a manual payment method (manual, with its payment_instructions, mark_as_paid and is_connected) or a connected payment provider (auto, with its branding: logo_dark, logo_light).
TypeScript Definition
typescript
CreditLinePaymentMethod: {{
id?: $Read<string>;
name: string;
slug?: string;
description: string;
/** @description `manual` methods only. */
payment_instructions?: $Read<string>;
/** @description `manual` methods only: when `true`, a payment with the method is recorded as paid as soon as it is created. */
mark_as_paid?: $Read<boolean>;
/** @description `manual` methods only. Derived from `status`: `true` when it is `active`. */
is_connected?: $Read<boolean>;
/**
* @description `manual` for store-defined payment methods; `auto` for connected payment service providers.
* @enum {unknown}
*/
type?: "auto" | "manual";
/** @description `true` when the option is linked in the store credit-line payment method configuration. */
used_in_credit_line?: $Read<boolean>;
/** @description IDs of the sales channels the method is offered on: its manual payment method's or payment provider's `channels`. Empty: every channel. */
channels?: $Read<string[]>;
/** @enum {unknown} */
status?: $Read<"active" | "inactive">;
logo_dark?: $Read<string | null>;
logo_light?: $Read<string | null>;
created_at?: $Read<string>;
modified_at?: $Read<string>;
};
}OpenAPI Schema
json
{
"title": "CreditLinePaymentMethod",
"description": "A payment method linked to the store credit line, as returned inside `StoreConfig.credit_line`. Read-only projection of a manual payment method (`manual`, with its `payment_instructions`, `mark_as_paid` and `is_connected`) or a connected payment provider (`auto`, with its branding: `logo_dark`, `logo_light`).",
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string"
},
"payment_instructions": {
"description": "`manual` methods only.",
"type": "string",
"readOnly": true
},
"mark_as_paid": {
"description": "`manual` methods only: when `true`, a payment with the method is recorded as paid as soon as it is created.",
"type": "boolean",
"readOnly": true
},
"is_connected": {
"description": "`manual` methods only. Derived from `status`: `true` when it is `active`.",
"type": "boolean",
"readOnly": true
},
"type": {
"description": "`manual` for store-defined payment methods; `auto` for connected payment service providers.",
"enum": [
"auto",
"manual"
]
},
"used_in_credit_line": {
"description": "`true` when the option is linked in the store credit-line payment method configuration.",
"type": "boolean",
"readOnly": true
},
"channels": {
"description": "IDs of the sales channels the method is offered on: its manual payment method's or payment provider's `channels`. Empty: every channel.",
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"status": {
"enum": [
"active",
"inactive"
],
"readOnly": true
},
"logo_dark": {
"type": [
"string",
"null"
],
"readOnly": true
},
"logo_light": {
"type": [
"string",
"null"
],
"readOnly": true
},
"created_at": {
"type": "string",
"readOnly": true
},
"modified_at": {
"type": "string",
"readOnly": true
}
},
"x-tags": [
"Store"
]
}Auto-generated from OpenAPI spec and TypeScript definitions