Public API v2: Custom Pricing

Special prices for groups of customers: a discount, an increase or a fixed price on chosen products, optionally per market and on a schedule.


Scopes	`custom-pricing:read`, `custom-pricing:write`
Plan	Plans with Custom Pricing; otherwise `403`
Takes effect	Saved in the app; reaches the storefront at the next upload.

Every response has the same envelope (success, status, data, meta; see Responses). Returns below describes data. The examples are real calls; the rules were created disabled.

Good to know

market_ids takes region markets only.
On the Free plan a store has one Custom Pricing rule at most, bulk-upsert included.
POST /rules/{id}/product-conditions/bulk-delete removes products from the rule: send the one list that matches its product_condition_type, up to 250 entries. Entries not in the rule are skipped.
On a rule with product_condition_type: all, product-conditions/bulk-delete answers 422: there is no list to remove from.
Prices reach the storefront and checkout at the next upload.

The rule object

What every read returns. Lists come back as [] when empty, never null.

idstringread-only

Rule id.

namestring

Rule name.

priorityinteger

Lower number wins; see Rules.

statusenum

disabled rules are kept but not applied. One of disabled, enabled.

CustomersCommon object

Who gets the rule.

Show fields

apply_toenum

all everyone, logged in or not · logged_in any logged-in customer · non_logged_in visitors who are not logged in · customer_ids the listed customers · customer_tags customers with any of the tags · company_location the listed B2B company locations. Accepted here: all, logged_in, non_logged_in, customer_ids, customer_tags, company_location.

customer_ids[string]

Used when apply_to is customer_ids; required and not empty then.

customer_tags[string]

Used when apply_to is customer_tags; required and not empty then.

company_location_ids[string]

Used when apply_to is company_location; required and not empty then.

exclude_fromenum

none (default) · customer_tags · customer_ids · company_location. Excluded customers stay out even when apply_to includes them. Accepted here: none, customer_tags, customer_ids, company_location.

exc_customer_tags[string]

Used when exclude_from is customer_tags.

exc_customers[string]

Used when exclude_from is customer_ids.

exc_company_location_ids[string]

Used when exclude_from is company_location.

ProductsCommon object

Which products the rule covers.

Show fields

product_condition_typeenum

all every product · by_ids · by_collections · by_tags · by_variants. Accepted here: all, by_ids, by_collections, by_tags, by_variants.

product_ids[string]

Used when the type is by_ids; required and not empty then.

product_collections[string]

Used when the type is by_collections; required and not empty then.

product_tags[string]

Used when the type is by_tags; required and not empty then.

variant_ids[string]

Used when the type is by_variants; required and not empty then.

exc_product_typeenum

none (default) or one of the types above: these products are left out. Accepted here: none, by_ids, by_collections, by_tags, by_variants.

exc_specific_products[string]

Used when exc_product_type is by_ids.

exc_product_collections[string]

Used when exc_product_type is by_collections.

exc_product_tags[string]

Used when exc_product_type is by_tags.

exc_product_variants[string]

Used when exc_product_type is by_variants.

MarketsCommon object

Which markets the rule covers.

Show fields

market_condition_typeenum

all (default) every market · by_ids the listed markets. Accepted here: all, by_ids.

market_ids[string]

Shopify market ids.

discount_typeenum

One of apply_fixed, decrease_fixed, decrease_percentage, apply_increased_fixed, increase_fixed, increase_percentage, set_fixed_price.

discount_valuestring

ScheduleCommon object

When the rule applies.

Show fields

start_atstring

UTC date and time ending in Z; null or left out: starts at once.

end_atstring

After start_at; null or left out: never ends.

created_atstring or nullread-only

UTC, ending in Z.

updated_atstring or nullread-only

UTC, ending in Z.

{
  "id": "90718",
  "name": "VIP 10%",
  "priority": 1,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_ids": [],
  "customer_tags": [
    "vip"
  ],
  "company_location_ids": [],
  "exclude_from": "none",
  "exc_customer_tags": [],
  "exc_customers": [],
  "exc_company_location_ids": [],
  "product_condition_type": "by_collections",
  "product_ids": [],
  "product_collections": [
    "482901234567"
  ],
  "product_tags": [],
  "variant_ids": [],
  "exc_product_type": "none",
  "exc_specific_products": [],
  "exc_product_collections": [],
  "exc_product_tags": [],
  "exc_product_variants": [],
  "market_condition_type": "all",
  "market_ids": [],
  "discount_type": "decrease_percentage",
  "discount_value": "10.00",
  "start_at": "2026-10-31T17:00:00.000Z",
  "end_at": null,
  "created_at": "2026-10-21T09:32:48.000Z",
  "updated_at": "2026-10-21T09:32:48.000Z"
}

List rules

GET/api/v2/custom-pricing/rules

Scope custom-pricing:readCost 10

List rules, newest first.

Query parameters

limitinteger

1–250, default 50. See Paging.

cursorstring

next_cursor or prev_cursor of the last page; leave out for the first page. Keep the same filters on every page.

filter_statusenum

One of disabled, enabled.

filter_namestring

Part of the name, any case. 1–200 characters.

Returns

data[Rule]

The rules of this page; [] when there are none.

meta.paginationobject

limit, next_cursor, prev_cursor and links to the next and previous pages.

Request
Response

curl -X GET "https://solution-public-api.bss-b2b.solutions/api/v2/custom-pricing/rules?limit=2&filter_name=VIP" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"

{
  "success": true,
  "status": "success",
  "data": [
    {
      "id": "90718",
      "name": "VIP 10%",
      "priority": 1,
      "status": "disabled",
      "apply_to": "customer_tags",
      "customer_ids": [],
      "customer_tags": [
        "vip"
      ],
      "company_location_ids": [],
      "exclude_from": "none",
      "exc_customer_tags": [],
      "exc_customers": [],
      "exc_company_location_ids": [],
      "product_condition_type": "by_collections",
      "product_ids": [],
      "product_collections": [
        "482901234567"
      ],
      "product_tags": [],
      "variant_ids": [],
      "exc_product_type": "none",
      "exc_specific_products": [],
      "exc_product_collections": [],
      "exc_product_tags": [],
      "exc_product_variants": [],
      "market_condition_type": "all",
      "market_ids": [],
      "discount_type": "decrease_percentage",
      "discount_value": "10.00",
      "start_at": "2026-10-31T17:00:00.000Z",
      "end_at": null,
      "created_at": "2026-10-21T09:32:48.000Z",
      "updated_at": "2026-10-21T09:32:48.000Z"
    }
  ],
  "meta": {
    "timestamp": "2026-10-21T09:32:50.797Z",
    "version": "v2",
    "request_id": "fbdc5205-5f7e-45d4-a6e2-dd283106c2b8",
    "rate_limit": {
      "cost": 10,
      "limit": 600,
      "remaining": 590,
      "restore_rate": 10
    },
    "pagination": {
      "limit": 2,
      "next_cursor": null,
      "prev_cursor": null,
      "links": {
        "self": "/api/v2/custom-pricing/rules?limit=2&filter_name=VIP",
        "next": null,
        "prev": null
      }
    }
  }
}

Create a rule

POST/api/v2/custom-pricing/rules

Scope custom-pricing:writeCost 11

Create a rule.

The body of POST /rules, PUT /rules/{id} and each element of bulk-upsert (add id to replace a rule). PUT replaces the whole rule: optional fields left out go back to their defaults. Fields not listed here are refused with 422.

Arguments

namestringrequired

Rule name. 1–200 characters.

priorityintegerrequired

Lower number wins; see Rules. 0–99.

statusenumrequired

disabled rules are kept but not applied. One of disabled, enabled.

CustomersCommon objectrequired

Who gets the rule.

Show fields

apply_toenum

customer_ids[string]

Used when apply_to is customer_ids; required and not empty then.

customer_tags[string]

Used when apply_to is customer_tags; required and not empty then.

company_location_ids[string]

Used when apply_to is company_location; required and not empty then.

exclude_fromenum

exc_customer_tags[string]

Used when exclude_from is customer_tags.

exc_customers[string]

Used when exclude_from is customer_ids.

exc_company_location_ids[string]

Used when exclude_from is company_location.

ProductsCommon objectrequired

Which products the rule covers.

Show fields

product_condition_typeenum

all every product · by_ids · by_collections · by_tags · by_variants. Accepted here: all, by_ids, by_collections, by_tags, by_variants.

product_ids[string]

Used when the type is by_ids; required and not empty then.

product_collections[string]

Used when the type is by_collections; required and not empty then.

product_tags[string]

Used when the type is by_tags; required and not empty then.

variant_ids[string]

Used when the type is by_variants; required and not empty then.

exc_product_typeenum

none (default) or one of the types above: these products are left out. Accepted here: none, by_ids, by_collections, by_tags, by_variants.

exc_specific_products[string]

Used when exc_product_type is by_ids.

exc_product_collections[string]

Used when exc_product_type is by_collections.

exc_product_tags[string]

Used when exc_product_type is by_tags.

exc_product_variants[string]

Used when exc_product_type is by_variants.

MarketsCommon object

Which markets the rule covers.

Show fields

market_condition_typeenum

all (default) every market · by_ids the listed markets. Accepted here: all, by_ids.

market_ids[string]

Shopify market ids.

discount_typeenumrequired

apply_fixed: Apply a decreasing price: the price becomes the value where that is lower than the current price; higher, the price stays.
decrease_fixed: Take a fixed amount off the price.
decrease_percentage: Take a percentage off the price (at most 100).
apply_increased_fixed: Apply an increasing price: the price becomes the value.
increase_fixed: Add a fixed amount to the price.
increase_percentage: Add a percentage to the price.
set_fixed_price: Set a fixed price; lowers prices only — products already at or below the value keep their price. Must be greater than 0.

discount_valuestringrequired

Decimal string, up to 2 decimals.

ScheduleCommon object

When the rule applies.

Show fields

start_atstring

UTC date and time ending in Z; null or left out: starts at once.

end_atstring

After start_at; null or left out: never ends.

Returns

dataRule

The new rule.

Request
Response

curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/custom-pricing/rules" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP 10%",
  "priority": 1,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_tags": [
    "vip"
  ],
  "product_condition_type": "by_collections",
  "product_collections": [
    "482901234567"
  ],
  "discount_type": "decrease_percentage",
  "discount_value": "10",
  "start_at": "2026-10-31T17:00:00Z",
  "end_at": null
}'

{
  "success": true,
  "status": "success",
  "data": {
    "id": "90718",
    "name": "VIP 10%",
    "priority": 1,
    "status": "disabled",
    "apply_to": "customer_tags",
    "customer_ids": [],
    "customer_tags": [
      "vip"
    ],
    "company_location_ids": [],
    "exclude_from": "none",
    "exc_customer_tags": [],
    "exc_customers": [],
    "exc_company_location_ids": [],
    "product_condition_type": "by_collections",
    "product_ids": [],
    "product_collections": [
      "482901234567"
    ],
    "product_tags": [],
    "variant_ids": [],
    "exc_product_type": "none",
    "exc_specific_products": [],
    "exc_product_collections": [],
    "exc_product_tags": [],
    "exc_product_variants": [],
    "market_condition_type": "all",
    "market_ids": [],
    "discount_type": "decrease_percentage",
    "discount_value": "10.00",
    "start_at": "2026-10-31T17:00:00.000Z",
    "end_at": null,
    "created_at": "2026-10-21T09:32:48.000Z",
    "updated_at": "2026-10-21T09:32:48.000Z"
  },
  "meta": {
    "timestamp": "2026-10-21T09:32:48.151Z",
    "version": "v2",
    "request_id": "7567d695-3ffe-46f2-ada0-0e0453a77cc6",
    "rate_limit": {
      "cost": 11,
      "limit": 600,
      "remaining": 589,
      "restore_rate": 10
    }
  }
}

Get a rule

GET/api/v2/custom-pricing/rules/{id}

Scope custom-pricing:readCost 10

Get a rule.

Path parameters

idstringrequired

Rule id.

Returns

dataRule

The rule. An id that does not exist answers 404 RESOURCE_NOT_FOUND.

Request
Response

curl -X GET "https://solution-public-api.bss-b2b.solutions/api/v2/custom-pricing/rules/90718" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"

{
  "success": true,
  "status": "success",
  "data": {
    "id": "90718",
    "name": "VIP 10%",
    "priority": 1,
    "status": "disabled",
    "apply_to": "customer_tags",
    "customer_ids": [],
    "customer_tags": [
      "vip"
    ],
    "company_location_ids": [],
    "exclude_from": "none",
    "exc_customer_tags": [],
    "exc_customers": [],
    "exc_company_location_ids": [],
    "product_condition_type": "by_collections",
    "product_ids": [],
    "product_collections": [
      "482901234567"
    ],
    "product_tags": [],
    "variant_ids": [],
    "exc_product_type": "none",
    "exc_specific_products": [],
    "exc_product_collections": [],
    "exc_product_tags": [],
    "exc_product_variants": [],
    "market_condition_type": "all",
    "market_ids": [],
    "discount_type": "decrease_percentage",
    "discount_value": "10.00",
    "start_at": "2026-10-31T17:00:00.000Z",
    "end_at": null,
    "created_at": "2026-10-21T09:32:48.000Z",
    "updated_at": "2026-10-21T09:32:48.000Z"
  },
  "meta": {
    "timestamp": "2026-10-21T09:32:49.482Z",
    "version": "v2",
    "request_id": "713072c5-6ae3-41ff-8f23-39d82d545983",
    "rate_limit": {
      "cost": 10,
      "limit": 600,
      "remaining": 590,
      "restore_rate": 10
    }
  }
}

Replace a rule

PUT/api/v2/custom-pricing/rules/{id}

Scope custom-pricing:writeCost 11

Replace a rule; optional fields left out go back to their defaults.

Path parameters

idstringrequired

Rule id.

Arguments

The same fields as Create a rule.

Returns

dataRule

The rule after the change.

Request
Response

curl -X PUT "https://solution-public-api.bss-b2b.solutions/api/v2/custom-pricing/rules/90718" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP 10% (updated)",
  "priority": 2,
  "status": "disabled",
  "apply_to": "customer_tags",
  "customer_tags": [
    "vip"
  ],
  "product_condition_type": "by_collections",
  "product_collections": [
    "482901234567"
  ],
  "discount_type": "decrease_percentage",
  "discount_value": "10",
  "start_at": "2026-10-31T17:00:00Z",
  "end_at": null
}'

{
  "success": true,
  "status": "success",
  "data": {
    "id": "90718",
    "name": "VIP 10% (updated)",
    "priority": 2,
    "status": "disabled",
    "apply_to": "customer_tags",
    "customer_ids": [],
    "customer_tags": [
      "vip"
    ],
    "company_location_ids": [],
    "exclude_from": "none",
    "exc_customer_tags": [],
    "exc_customers": [],
    "exc_company_location_ids": [],
    "product_condition_type": "by_collections",
    "product_ids": [],
    "product_collections": [
      "482901234567"
    ],
    "product_tags": [],
    "variant_ids": [],
    "exc_product_type": "none",
    "exc_specific_products": [],
    "exc_product_collections": [],
    "exc_product_tags": [],
    "exc_product_variants": [],
    "market_condition_type": "all",
    "market_ids": [],
    "discount_type": "decrease_percentage",
    "discount_value": "10.00",
    "start_at": "2026-10-31T17:00:00.000Z",
    "end_at": null,
    "created_at": "2026-10-21T09:32:48.000Z",
    "updated_at": "2026-10-21T09:32:53.000Z"
  },
  "meta": {
    "timestamp": "2026-10-21T09:32:53.488Z",
    "version": "v2",
    "request_id": "d20097c4-2102-4f14-8458-72516b2d22ac",
    "rate_limit": {
      "cost": 11,
      "limit": 600,
      "remaining": 589,
      "restore_rate": 10
    }
  }
}

Delete a rule

DEL/api/v2/custom-pricing/rules/{id}

Scope custom-pricing:writeCost 11

Delete a rule.

Path parameters

idstringrequired

Rule id.

Returns

data.idstring

Id of the deleted rule.

data.deletedboolean

true.

Request
Response

curl -X DELETE "https://solution-public-api.bss-b2b.solutions/api/v2/custom-pricing/rules/90718" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"

{
  "success": true,
  "status": "success",
  "data": {
    "id": "90718",
    "deleted": true
  },
  "meta": {
    "timestamp": "2026-10-21T09:32:57.505Z",
    "version": "v2",
    "request_id": "52582155-918e-42d5-87be-0ca13db334a0",
    "rate_limit": {
      "cost": 11,
      "limit": 600,
      "remaining": 589,
      "restore_rate": 10
    }
  }
}

Remove products from a rule

POST/api/v2/custom-pricing/rules/{id}/product-conditions/bulk-delete

Scope custom-pricing:writeCost 11

Remove items from the rule’s product list; items not in it are skipped.

Path parameters

idstringrequired

Rule id.

Arguments

product_ids[string]

1–250 items.

product_collections[string]

1–250 items.

product_tags[string]

1–250 items.

variant_ids[string]

1–250 items.

Returns

dataRule

The rule after the change.

Request
Response

curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/custom-pricing/rules/90718/product-conditions/bulk-delete" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "product_collections": [
    "482901234567"
  ]
}'

{
  "success": true,
  "status": "success",
  "data": {
    "id": "90718",
    "name": "VIP 10%",
    "priority": 1,
    "status": "disabled",
    "apply_to": "customer_tags",
    "customer_ids": [],
    "customer_tags": [
      "vip"
    ],
    "company_location_ids": [],
    "exclude_from": "none",
    "exc_customer_tags": [],
    "exc_customers": [],
    "exc_company_location_ids": [],
    "product_condition_type": "by_collections",
    "product_ids": [],
    "product_collections": [],
    "product_tags": [],
    "variant_ids": [],
    "exc_product_type": "none",
    "exc_specific_products": [],
    "exc_product_collections": [],
    "exc_product_tags": [],
    "exc_product_variants": [],
    "market_condition_type": "all",
    "market_ids": [],
    "discount_type": "decrease_percentage",
    "discount_value": "10.00",
    "start_at": "2026-10-31T17:00:00.000Z",
    "end_at": null,
    "created_at": "2026-10-21T09:32:48.000Z",
    "updated_at": "2026-10-21T09:32:52.000Z"
  },
  "meta": {
    "timestamp": "2026-10-21T09:32:52.150Z",
    "version": "v2",
    "request_id": "9c016a44-4102-4129-8443-91a828c62290",
    "rate_limit": {
      "cost": 11,
      "limit": 600,
      "remaining": 589,
      "restore_rate": 10
    }
  }
}

Create or replace rules in bulk

POST/api/v2/custom-pricing/rules/bulk-upsert

Scope custom-pricing:writeCost ceil(10 + 0.4 × rules)

Create or replace up to 250 rules; each one succeeds or fails on its own.

See Bulk & idempotency.

Arguments

rules[object]required

1–250 rules, each with the fields of Create a rule.

Show fields

idstring

Set it to replace that rule, as Replace a rule does; leave it out to create one.

Returns

data.results[object]

One entry per rule, in the order sent.

Show fields

indexinteger

Position of the rule in rules.

idstring

Rule id.

resultenum

created, updated or error.

errorobject

code and message, only when result is error.

data.summaryobject

total, succeeded, failed.

Request
Response

curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/custom-pricing/rules/bulk-upsert" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "rules": [
    {
      "name": "VIP 10% B",
      "priority": 1,
      "status": "disabled",
      "apply_to": "customer_tags",
      "customer_tags": [
        "vip"
      ],
      "product_condition_type": "by_collections",
      "product_collections": [
        "482901234567"
      ],
      "discount_type": "decrease_percentage",
      "discount_value": "10",
      "start_at": "2026-10-31T17:00:00Z",
      "end_at": null
    },
    {
      "name": "VIP 10% (bulk)",
      "priority": 1,
      "status": "disabled",
      "apply_to": "customer_tags",
      "customer_tags": [
        "vip"
      ],
      "product_condition_type": "by_collections",
      "product_collections": [
        "482901234567"
      ],
      "discount_type": "decrease_percentage",
      "discount_value": "10",
      "start_at": "2026-10-31T17:00:00Z",
      "end_at": null,
      "id": "90718"
    }
  ]
}'

{
  "success": true,
  "status": "success",
  "data": {
    "results": [
      {
        "index": 0,
        "id": "90719",
        "result": "created"
      },
      {
        "index": 1,
        "id": "90718",
        "result": "updated"
      }
    ],
    "summary": {
      "total": 2,
      "succeeded": 2,
      "failed": 0
    }
  },
  "meta": {
    "timestamp": "2026-10-21T09:32:54.839Z",
    "version": "v2",
    "request_id": "4e178e47-c5f7-4c59-a92f-8fd1f14da11b",
    "rate_limit": {
      "cost": 11,
      "limit": 600,
      "remaining": 589,
      "restore_rate": 10
    }
  }
}

Delete rules in bulk

POST/api/v2/custom-pricing/rules/bulk-delete

Scope custom-pricing:writeCost ceil(10 + 0.4 × rules)

Delete up to 250 rules; an unknown id fails on its own.

See Bulk & idempotency.

Arguments

ids[string]required

1–250 rule ids.

Returns

data.results[object]

One entry per id: index, id, result (deleted or error) and error (code, message) when it failed.

data.summaryobject

total, succeeded, failed.

Request
Response

curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/custom-pricing/rules/bulk-delete" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    "90719",
    "999999999"
  ]
}'

{
  "success": true,
  "status": "success",
  "data": {
    "results": [
      {
        "index": 0,
        "id": "90719",
        "result": "deleted"
      },
      {
        "index": 1,
        "id": "999999999",
        "result": "error",
        "error": {
          "code": "RESOURCE_NOT_FOUND",
          "message": "Resource not found"
        }
      }
    ],
    "summary": {
      "total": 2,
      "succeeded": 1,
      "failed": 1
    }
  },
  "meta": {
    "timestamp": "2026-10-21T09:32:56.173Z",
    "version": "v2",
    "request_id": "f68dd2d9-6cd0-432b-8b94-ea2e3481066d",
    "rate_limit": {
      "cost": 11,
      "limit": 600,
      "remaining": 589,
      "restore_rate": 10
    }
  }
}

Upload rules to the storefront

POST/api/v2/custom-pricing/rules/upload

Scope custom-pricing:writeCost 20

Upload the rules to the storefront, as the app does.

The body is empty. See Upload.

Returns

data.statusenum

uploaded, or partial_success when some rules did not reach the storefront.

data.skippedobject

capacity_exceeded, write_failed and rule_id_range; see Upload.

Request
Response

curl -X POST "https://solution-public-api.bss-b2b.solutions/api/v2/custom-pricing/rules/upload" \
  -H "X-API-Key: $B2B_API_KEY" \
  -H "X-Shop-Domain: your-store.myshopify.com"

Answer of the Net Terms upload; every module answers in this shape.

{
  "success": true,
  "status": "success",
  "data": {
    "status": "uploaded",
    "skipped": {
      "capacity_exceeded": 0,
      "write_failed": 0,
      "rule_id_range": null
    }
  },
  "meta": {
    "timestamp": "2026-10-21T09:34:46.663Z",
    "version": "v2",
    "request_id": "db2079e7-e134-412e-9943-e2c2b29a9e8c",
    "rate_limit": {
      "cost": 20,
      "limit": 600,
      "remaining": 580,
      "restore_rate": 10
    }
  }
}