# Slope API API

> Slope API API on Apizie: 28 endpoints (Get merchant, List orders, Create an order, Get an order, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/open-data:slope/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:slope`
- Category: Open Data
- Status: byok
- Source: https://slopepay.com
- Page: https://apizie.tech/api/open-data/slope
- OpenAPI: https://apizie.tech/api/open-data/slope/openapi.json

The Slope REST API

## Endpoints

### Get merchant
`GET https://apizie.tech/v1/open-data:slope/merchants-get-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| expand | array | no | The nested objects to expand as part of the response. |

### List orders
`GET https://apizie.tech/v1/open-data:slope/orders-list-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | The maximum number of objects to list. |
| orderBy | array | no | The object attribute(s) to sort by. |
| order | string | no | The direction to sort by, one of `asc` or `desc`. |
| beforeCursor | string | no | The cursor used to fetch the previous page of objects. |
| afterCursor | string | no | The cursor used to fetch the next page of objects. |
| filter | object | no |  |
| expand | array | no | The nested objects to expand as part of the response. |

### Create an order
`POST https://apizie.tech/v1/open-data:slope/orders-create-new-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get an order
`GET https://apizie.tech/v1/open-data:slope/orders-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Update an order
`POST https://apizie.tech/v1/open-data:slope/orders-update-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | yes | JSON request body |

### Generate an order intent
`POST https://apizie.tech/v1/open-data:slope/orders-generate-intent-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| timeoutMs | string | yes |  |

### Submit an order
`POST https://apizie.tech/v1/open-data:slope/orders-submit-order-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | yes | JSON request body |

### Open an order
`POST https://apizie.tech/v1/open-data:slope/orders-open-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | yes | JSON request body |

### Finalize an order
`POST https://apizie.tech/v1/open-data:slope/orders-finalize-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Cancel an order
`POST https://apizie.tech/v1/open-data:slope/orders-cancel-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Refund an order
`POST https://apizie.tech/v1/open-data:slope/orders-refund-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | yes | JSON request body |

### Reset an order
`POST https://apizie.tech/v1/open-data:slope/orders-reset-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### List all payout accounts
`GET https://apizie.tech/v1/open-data:slope/payout-accounts-list-all-payout-accounts` (byok)

### Create a payout account
`POST https://apizie.tech/v1/open-data:slope/payout-accounts-create-with-external-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a payout account
`GET https://apizie.tech/v1/open-data:slope/payout-accounts-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Update a payout account
`POST https://apizie.tech/v1/open-data:slope/payout-accounts-update-with-external-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | yes | JSON request body |

### Delete a payout account
`POST https://apizie.tech/v1/open-data:slope/payout-accounts-delete-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### List invoices
`GET https://apizie.tech/v1/open-data:slope/invoices-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | The maximum number of objects to list. |
| orderBy | array | no | The object attribute(s) to sort by. |
| order | string | no | The direction to sort by, one of `asc` or `desc`. |
| beforeCursor | string | no | The cursor used to fetch the previous page of objects. |
| afterCursor | string | no | The cursor used to fetch the next page of objects. |
| filter | object | no |  |
| expand | array | no | The nested objects to expand as part of the response. |

### Create an invoice
`POST https://apizie.tech/v1/open-data:slope/invoices-create-new-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get an invoice
`GET https://apizie.tech/v1/open-data:slope/invoices-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Open an invoice
`POST https://apizie.tech/v1/open-data:slope/invoices-open-draft` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Void an invoice
`POST https://apizie.tech/v1/open-data:slope/invoices-void-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Cancel an invoice
`POST https://apizie.tech/v1/open-data:slope/invoices-cancel-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### List customers
`GET https://apizie.tech/v1/open-data:slope/customers-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | The maximum number of objects to list. |
| orderBy | array | no | The object attribute(s) to sort by. |
| order | string | no | The direction to sort by, one of `asc` or `desc`. |
| beforeCursor | string | no | The cursor used to fetch the previous page of objects. |
| afterCursor | string | no | The cursor used to fetch the next page of objects. |
| filter | object | no |  |
| expand | array | no | The nested objects to expand as part of the response. |

### Create a customer
`POST https://apizie.tech/v1/open-data:slope/customers-register-new-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a customer
`GET https://apizie.tech/v1/open-data:slope/customers-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The customer ID assigned by Slope _or_ the customer external ID assigned by you. |
| expand | array | no | The nested objects to expand as part of the response. |

### Update a customer
`POST https://apizie.tech/v1/open-data:slope/customers-update-existing-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The customer ID assigned by Slope _or_ the customer external ID assigned by you. |
| expand | array | no | The nested objects to expand as part of the response. |
| body | object | yes | JSON request body |

### Generate an customer intent
`POST https://apizie.tech/v1/open-data:slope/customers-generate-intent-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

## Example
```
curl "https://apizie.tech/v1/open-data:slope/merchants-get-settings" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Slope API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/open-data:slope/merchants-get-settings with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Slope API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Slope API itself also needs your own key from api.slope.so.

### Can AI agents use the Slope API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:slope.

### What is the status of the Slope API API?
Needs your own provider key (bring your own key)