Choose a version:

paymentTermsTemplates

query

The list of payment terms templates eligible for all shops and users.

Arguments

Anchor to paymentTermsTypepaymentTermsType • PaymentTermsType: The payment terms type to filter the payment terms templates list.

Was this section helpful?

Anchor to Possible returnsPossible returns

PaymentTermsTemplate

•

[PaymentTermsTemplate!]!

Represents the payment terms template object.

description• String! non-null: The description of the payment terms template.
dueInDays• Int: The number of days between the issued date and due date if this is the net type of payment terms.
id• ID! non-null: A globally-unique ID.
name• String! non-null: The name of the payment terms template.
paymentTermsType• PaymentTermsType! non-null: The type of the payment terms template.
translatedName• String! non-null: The translated payment terms template name.

Was this section helpful?

Get the available payment terms templates

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

paymentTermsTemplates {

name

paymentTermsType

dueInDays

description

translatedName

}

}`,

);

const data = await response.json();

query {
  paymentTermsTemplates {
    id
    name
    paymentTermsType
    dueInDays
    description
    translatedName
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { paymentTermsTemplates { id name paymentTermsType dueInDays description translatedName } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    paymentTermsTemplates {
      id
      name
      paymentTermsType
      dueInDays
      description
      translatedName
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    paymentTermsTemplates {
      id
      name
      paymentTermsType
      dueInDays
      description
      translatedName
    }
  }`,
});

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
  query {
    paymentTermsTemplates {
      id
      name
      paymentTermsType
      dueInDays
      description
      translatedName
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"paymentTermsTemplates": [

{

"id": "gid://shopify/PaymentTermsTemplate/1",

"name": "Due on receipt",

"paymentTermsType": "RECEIPT",

"dueInDays": null,

"description": "Due on receipt",

"translatedName": "Due on receipt"

{

"id": "gid://shopify/PaymentTermsTemplate/9",

"name": "Due on fulfillment",

"paymentTermsType": "FULFILLMENT",

"dueInDays": null,

"description": "Due on fulfillment",

"translatedName": "Due on fulfillment"

{

"id": "gid://shopify/PaymentTermsTemplate/2",

"name": "Net 7",

"paymentTermsType": "NET",

"dueInDays": 7,

"description": "Within 7 days",

"translatedName": "Net 7"

{

"id": "gid://shopify/PaymentTermsTemplate/3",

"name": "Net 15",

"paymentTermsType": "NET",

"dueInDays": 15,

"description": "Within 15 days",

"translatedName": "Net 15"

{

"id": "gid://shopify/PaymentTermsTemplate/4",

"name": "Net 30",

"paymentTermsType": "NET",

"dueInDays": 30,

"description": "Within 30 days",

"translatedName": "Net 30"

{

"id": "gid://shopify/PaymentTermsTemplate/8",

"name": "Net 45",

"paymentTermsType": "NET",

"dueInDays": 45,

"description": "Within 45 days",

"translatedName": "Net 45"

{

"id": "gid://shopify/PaymentTermsTemplate/5",

"name": "Net 60",

"paymentTermsType": "NET",

"dueInDays": 60,

"description": "Within 60 days",

"translatedName": "Net 60"

{

"id": "gid://shopify/PaymentTermsTemplate/6",

"name": "Net 90",

"paymentTermsType": "NET",

"dueInDays": 90,

"description": "Within 90 days",

"translatedName": "Net 90"

{

"id": "gid://shopify/PaymentTermsTemplate/7",

"name": "Fixed",

"paymentTermsType": "FIXED",

"dueInDays": null,

"description": "Fixed date",

"translatedName": "Fixed"

}

]

}