Skip to content

ManualPaymentMethod ​

Type: schema

TypeScript Definition ​

typescript
ManualPaymentMethod: {{
            id?: $Read<string>;
            name: string;
            slug?: string;
            description: string;
            /** @description `true` when the option is linked in the store credit-line payment method configuration. */
            used_in_credit_line?: $Read<boolean>;
            /** @description Derived from `status`. `true` when `status` is `active`. */
            is_connected?: $Read<boolean>;
            payment_instructions: string;
            /**
             * @description When `true`, a payment with this method is recorded as paid as soon as it is created, as cash taken at the counter is. Use `channels` to keep it off channels where shoppers pay by themselves.
             * @default false
             */
            mark_as_paid: boolean;
            /** @description IDs of the sales channels the store offers this method on; an empty list offers it on every channel. Each must be one of the store's storefront channels. When read, IDs of deleted channels are left out, unless all of them were deleted: the method then keeps their IDs and is offered on no channel. */
            channels?: string[];
            /**
             * @description An `inactive` method is not offered on any channel.
             * @default active
             * @enum {unknown}
             */
            status: "active" | "inactive";
            created_at?: $Read<string>;
            modified_at?: $Read<string>;
        };
        /** ManualShippingRateCondition */
}

OpenAPI Schema ​

json
{
  "title": "ManualPaymentMethod",
  "type": "object",
  "required": [
    "name",
    "description",
    "payment_instructions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "used_in_credit_line": {
      "description": "`true` when the option is linked in the store credit-line payment method configuration.",
      "type": "boolean",
      "readOnly": true
    },
    "is_connected": {
      "description": "Derived from `status`. `true` when `status` is `active`.",
      "type": "boolean",
      "readOnly": true
    },
    "payment_instructions": {
      "type": "string"
    },
    "mark_as_paid": {
      "description": "When `true`, a payment with this method is recorded as paid as soon as it is created, as cash taken at the counter is. Use `channels` to keep it off channels where shoppers pay by themselves.",
      "type": "boolean",
      "default": false
    },
    "channels": {
      "description": "IDs of the sales channels the store offers this method on; an empty list offers it on every channel. Each must be one of the store's storefront channels. When read, IDs of deleted channels are left out, unless all of them were deleted: the method then keeps their IDs and is offered on no channel.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "status": {
      "description": "An `inactive` method is not offered on any channel.",
      "default": "active",
      "enum": [
        "active",
        "inactive"
      ]
    },
    "created_at": {
      "type": "string",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "readOnly": true
    }
  },
  "x-tags": [
    "Store"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: