---
title: paymentTermsCreate - GraphQL Admin
description: Create payment terms on an order. To create payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`.
api_version: 2025-10
api_name: admin
type: mutation
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/admin-graphql/latest/mutations/paymenttermscreate
  md: https://shopify.dev/docs/api/admin-graphql/latest/mutations/paymenttermscreate.md
---

# payment​Terms​Create

mutation

Requires `write_payment_terms` access scope. Also: The user must have access to orders or draft orders.

Create payment terms on an order. To create payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`.

## Arguments

* payment​Terms​Attributes

  [Payment​Terms​Create​Input!](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/PaymentTermsCreateInput)

  required

  The attributes used to create the payment terms.

* reference​Id

  [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)

  required

  Specifies the reference orderId to add the payment terms for.

***

## Payment​Terms​Create​Payload returns

* payment​Terms

  [Payment​Terms](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTerms)

  The created payment terms.

* user​Errors

  [\[Payment​Terms​Create​User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTermsCreateUserError)

  non-null

  The list of errors that occurred from executing the mutation.

***

## Examples

* ### Create due on receipt payment terms

  #### Description

  Create payment terms that indicate payment is due when the invoice is sent by the merchant.

  #### Query

  ```graphql
  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
      paymentTerms {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
  ```

  #### Variables

  ```json
  {
    "referenceId": "gid://shopify/Order/922426937",
    "paymentTermsAttributes": {
      "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
    }
  }
  ```

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) { paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) { paymentTerms { id } userErrors { field message } } }",
   "variables": {
      "referenceId": "gid://shopify/Order/922426937",
      "paymentTermsAttributes": {
        "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
      }
    }
  }'
  ```

  #### React Router

  ```javascript
  import { authenticate } from "../shopify.server";

  export const loader = async ({request}) => {
    const { admin } = await authenticate.admin(request);
    const response = await admin.graphql(
      `#graphql
    mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
      paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
        paymentTerms {
          id
        }
        userErrors {
          field
          message
        }
      }
    }`,
    {
      variables: {
          "referenceId": "gid://shopify/Order/922426937",
          "paymentTermsAttributes": {
              "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
          }
      },
    },
    );
    const json = await response.json();
    return json.data;
  }
  ```

  #### Ruby

  ```ruby
  session = ShopifyAPI::Auth::Session.new(
    shop: "your-development-store.myshopify.com",
    access_token: access_token
  )
  client = ShopifyAPI::Clients::Graphql::Admin.new(
    session: session
  )

  query = <<~QUERY
    mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
      paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
        paymentTerms {
          id
        }
        userErrors {
          field
          message
        }
      }
    }
  QUERY

  variables = {
    "referenceId": "gid://shopify/Order/922426937",
    "paymentTermsAttributes": {
      "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
    }
  }

  response = client.query(query: query, variables: variables)
  ```

  #### Node.js

  ```javascript
  const client = new shopify.clients.Graphql({session});
  const data = await client.query({
    data: {
      "query": `mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
        paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
          paymentTerms {
            id
          }
          userErrors {
            field
            message
          }
        }
      }`,
      "variables": {
          "referenceId": "gid://shopify/Order/922426937",
          "paymentTermsAttributes": {
              "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
          }
      },
    },
  });
  ```

  #### Response

  ```json
  {
    "paymentTermsCreate": {
      "paymentTerms": {
        "id": "gid://shopify/PaymentTerms/1054663035"
      },
      "userErrors": []
    }
  }
  ```

* ### Create fixed payment terms

  #### Description

  Create payment terms that indicate payment is due on a fixed date.

  #### Query

  ```graphql
  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
      paymentTerms {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
  ```

  #### Variables

  ```json
  {
    "referenceId": "gid://shopify/Order/922426937",
    "paymentTermsAttributes": {
      "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",
      "paymentSchedules": [
        {
          "dueAt": "2022-06-13T22:35:23.311Z"
        }
      ]
    }
  }
  ```

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) { paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) { paymentTerms { id } userErrors { field message } } }",
   "variables": {
      "referenceId": "gid://shopify/Order/922426937",
      "paymentTermsAttributes": {
        "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",
        "paymentSchedules": [
          {
            "dueAt": "2022-06-13T22:35:23.311Z"
          }
        ]
      }
    }
  }'
  ```

  #### React Router

  ```javascript
  import { authenticate } from "../shopify.server";

  export const loader = async ({request}) => {
    const { admin } = await authenticate.admin(request);
    const response = await admin.graphql(
      `#graphql
    mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
      paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
        paymentTerms {
          id
        }
        userErrors {
          field
          message
        }
      }
    }`,
    {
      variables: {
          "referenceId": "gid://shopify/Order/922426937",
          "paymentTermsAttributes": {
              "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",
              "paymentSchedules": [
                  {
                      "dueAt": "2022-06-13T22:35:23.311Z"
                  }
              ]
          }
      },
    },
    );
    const json = await response.json();
    return json.data;
  }
  ```

  #### Ruby

  ```ruby
  session = ShopifyAPI::Auth::Session.new(
    shop: "your-development-store.myshopify.com",
    access_token: access_token
  )
  client = ShopifyAPI::Clients::Graphql::Admin.new(
    session: session
  )

  query = <<~QUERY
    mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
      paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
        paymentTerms {
          id
        }
        userErrors {
          field
          message
        }
      }
    }
  QUERY

  variables = {
    "referenceId": "gid://shopify/Order/922426937",
    "paymentTermsAttributes": {
      "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",
      "paymentSchedules": [
        {
          "dueAt": "2022-06-13T22:35:23.311Z"
        }
      ]
    }
  }

  response = client.query(query: query, variables: variables)
  ```

  #### Node.js

  ```javascript
  const client = new shopify.clients.Graphql({session});
  const data = await client.query({
    data: {
      "query": `mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
        paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
          paymentTerms {
            id
          }
          userErrors {
            field
            message
          }
        }
      }`,
      "variables": {
          "referenceId": "gid://shopify/Order/922426937",
          "paymentTermsAttributes": {
              "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",
              "paymentSchedules": [
                  {
                      "dueAt": "2022-06-13T22:35:23.311Z"
                  }
              ]
          }
      },
    },
  });
  ```

  #### Response

  ```json
  {
    "paymentTermsCreate": {
      "paymentTerms": {
        "id": "gid://shopify/PaymentTerms/1054663034"
      },
      "userErrors": []
    }
  }
  ```

* ### Create net payment terms

  #### Description

  Create payment terms that indicate payment is due a set number of days after the invoice is sent.

  #### Query

  ```graphql
  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
      paymentTerms {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
  ```

  #### Variables

  ```json
  {
    "referenceId": "gid://shopify/Order/922426937",
    "paymentTermsAttributes": {
      "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/2",
      "paymentSchedules": [
        {
          "issuedAt": "2022-06-13T22:30:18.019Z"
        }
      ]
    }
  }
  ```

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) { paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) { paymentTerms { id } userErrors { field message } } }",
   "variables": {
      "referenceId": "gid://shopify/Order/922426937",
      "paymentTermsAttributes": {
        "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/2",
        "paymentSchedules": [
          {
            "issuedAt": "2022-06-13T22:30:18.019Z"
          }
        ]
      }
    }
  }'
  ```

  #### React Router

  ```javascript
  import { authenticate } from "../shopify.server";

  export const loader = async ({request}) => {
    const { admin } = await authenticate.admin(request);
    const response = await admin.graphql(
      `#graphql
    mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
      paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
        paymentTerms {
          id
        }
        userErrors {
          field
          message
        }
      }
    }`,
    {
      variables: {
          "referenceId": "gid://shopify/Order/922426937",
          "paymentTermsAttributes": {
              "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/2",
              "paymentSchedules": [
                  {
                      "issuedAt": "2022-06-13T22:30:18.019Z"
                  }
              ]
          }
      },
    },
    );
    const json = await response.json();
    return json.data;
  }
  ```

  #### Ruby

  ```ruby
  session = ShopifyAPI::Auth::Session.new(
    shop: "your-development-store.myshopify.com",
    access_token: access_token
  )
  client = ShopifyAPI::Clients::Graphql::Admin.new(
    session: session
  )

  query = <<~QUERY
    mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
      paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
        paymentTerms {
          id
        }
        userErrors {
          field
          message
        }
      }
    }
  QUERY

  variables = {
    "referenceId": "gid://shopify/Order/922426937",
    "paymentTermsAttributes": {
      "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/2",
      "paymentSchedules": [
        {
          "issuedAt": "2022-06-13T22:30:18.019Z"
        }
      ]
    }
  }

  response = client.query(query: query, variables: variables)
  ```

  #### Node.js

  ```javascript
  const client = new shopify.clients.Graphql({session});
  const data = await client.query({
    data: {
      "query": `mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
        paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
          paymentTerms {
            id
          }
          userErrors {
            field
            message
          }
        }
      }`,
      "variables": {
          "referenceId": "gid://shopify/Order/922426937",
          "paymentTermsAttributes": {
              "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/2",
              "paymentSchedules": [
                  {
                      "issuedAt": "2022-06-13T22:30:18.019Z"
                  }
              ]
          }
      },
    },
  });
  ```

  #### Response

  ```json
  {
    "paymentTermsCreate": {
      "paymentTerms": {
        "id": "gid://shopify/PaymentTerms/1054663033"
      },
      "userErrors": []
    }
  }
  ```

* ### paymentTermsCreate reference

[Open in GraphiQL](http://localhost:3457/graphiql?query=mutation%20PaymentTermsCreate\(%24referenceId%3A%20ID!%2C%20%24paymentTermsAttributes%3A%20PaymentTermsCreateInput!\)%20%7B%0A%20%20paymentTermsCreate\(referenceId%3A%20%24referenceId%2C%20paymentTermsAttributes%3A%20%24paymentTermsAttributes\)%20%7B%0A%20%20%20%20paymentTerms%20%7B%0A%20%20%20%20%20%20id%0A%20%20%20%20%7D%0A%20%20%20%20userErrors%20%7B%0A%20%20%20%20%20%20field%0A%20%20%20%20%20%20message%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D\&variables=%7B%0A%20%20%22referenceId%22%3A%20%22gid%3A%2F%2Fshopify%2FOrder%2F922426937%22%2C%0A%20%20%22paymentTermsAttributes%22%3A%20%7B%0A%20%20%20%20%22paymentTermsTemplateId%22%3A%20%22gid%3A%2F%2Fshopify%2FPaymentTermsTemplate%2F1%22%0A%20%20%7D%0A%7D)

```javascript
import { authenticate } from "../shopify.server";


export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
      paymentTerms {
        id
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "referenceId": "gid://shopify/Order/922426937",
        "paymentTermsAttributes": {
            "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}
```

##### GQL

```
mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
  paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
    paymentTerms {
      id
    }
    userErrors {
      field
      message
    }
  }
}
```

##### cURL

```
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) { paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) { paymentTerms { id } userErrors { field message } } }",
 "variables": {
    "referenceId": "gid://shopify/Order/922426937",
    "paymentTermsAttributes": {
      "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
    }
  }
}'
```

##### React Router

```
import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
      paymentTerms {
        id
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "referenceId": "gid://shopify/Order/922426937",
        "paymentTermsAttributes": {
            "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}
```

##### Node.js

```
const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
      paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
        paymentTerms {
          id
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "referenceId": "gid://shopify/Order/922426937",
        "paymentTermsAttributes": {
            "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
        }
    },
  },
});
```

##### Ruby

```
session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation PaymentTermsCreate($referenceId: ID!, $paymentTermsAttributes: PaymentTermsCreateInput!) {
    paymentTermsCreate(referenceId: $referenceId, paymentTermsAttributes: $paymentTermsAttributes) {
      paymentTerms {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "referenceId": "gid://shopify/Order/922426937",
  "paymentTermsAttributes": {
    "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
  }
}

response = client.query(query: query, variables: variables)
```

## Input variables

JSON

```json
{
  "referenceId": "gid://shopify/Order/922426937",
  "paymentTermsAttributes": {
    "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/1"
  }
}
```

## Response

JSON

```json
{
  "paymentTermsCreate": {
    "paymentTerms": {
      "id": "gid://shopify/PaymentTerms/1054663035"
    },
    "userErrors": []
  }
}
```