API explorerChangelog
API explorer
Changelog

Theme switcher

API Reference

Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

⚠️ Note: All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API. Get sales data, itemize payments, push orders to POS, and more.The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

https://app.theneo.io

Language Box

Status Codes

200

Everything worked as expected.

400

The request was unacceptable, often due to missing a required parameter.

401

The request was unacceptable, often due to missing a required parameter.

402

The parameters were valid but the request failed.

403

The API key doesnt have permissions to perform the request.

404

The requested resource does not exist.

Error Codes

api_connection_error

Failure to connect to API.

api_error

API errors cover any other type of problem (e.g., a temporary problem with servers), and are extremely uncommon.

authentication_error

Failure to properly authenticate yourself in the request.

card_error

Card errors are the most common type of error you should expect to handle. They result when the user enters a card that can't be charged for some reason.

idempotency_error

Idempotency errors occur when an Idempotency-Key is re-used on a request that does not match the first request's API endpoint and parameters.

invalid_request_error

Invalid request errors arise when your request has invalid parameters.

rate_limit_error

Too many requests hit the API too quickly.

validation_error

Errors triggered by our client-side libraries when failing to validate fields (e.g., when a card number or expiration date is invalid or incomplete).

Was this section helpful?

What made this section unhelpful for you?

Customer CRM API Example

🚀 Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Just import your API collection and we'll take care of the rest.

Please Note this is just a demo document, none of the endpoints here are real

Endpoints

POST
PUT
GET
POST
DELETE

Payments / Transaction Examples

All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API.Get sales data, itemize payments, push orders to POS, and more.

Note: The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.

In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

As an organization, you need to be careful while choosing a payment gateway option. It should be according to the customer’s experience on your websites through to cash flow to online sales. Make sure that you take care of at least 5 things mentioned below while choosing a payment gateway… 

  • Security should be the topmost priority. Make sure that it should be integrated with the 3D security and comply with the PCI Data Security Standard (PCI DSS).

  • Payout Time should be less to credit money in your bank account.

  • Integration need to be easy and simple or it can develop a custom-coded solution for your platform easily.

  • Multiple currencies should be handled by the payment gateway for the customers using different currencies across the world.

Was this section helpful?

What made this section unhelpful for you?

Endpoints

POST
PUT
GET
POST
POST
PUT
POST
Was this section helpful?

What made this section unhelpful for you?

Create order

Creates a new order that can include information about products for purchase and settings to apply to the purchase.

Header Parameters

Authorizationstring
Content-Typestring

Body Parameters

idempotency_keystring
orderobject

Show child attributes

Response

200
Object

Response Attributes

orderobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/v2/orders

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 curl --location 'https://app.theneo.io/v2/orders' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "idempotency_key": "8193148c-9586-11e6-99f9-28cfe92138cf", "order": { "reference_id": "my-order-001", "location_id": "057P5VYJ4A5X1", "line_items": [ { "name": "Best API Doc platform", "quantity": "1", "base_price_money": { "amount": 1599, "currency": "USD" } }, { "quantity": "2", "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB", "modifiers": [ { "catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ" } ], "applied_discounts": [ { "discount_uid": "one-dollar-off" } ] } ], "taxes": [ { "uid": "state-sales-tax", "name": "State Sales Tax", "percentage": "9", "scope": "ORDER" } ], "discounts": [ { "uid": "labor-day-sale", "name": "Labor Day Sale", "percentage": "5", "scope": "ORDER" }, { "uid": "membership-discount", "catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7", "scope": "ORDER" }, { "uid": "one-dollar-off", "name": "Sale - $1.00 off", "amount_money": { "amount": 100, "currency": "USD" }, "scope": "LINE_ITEM" } ] } }'

Response

{
  "order": {
    "id": "CAISENgvlJ6jLWAzERDzjyHVybY",
    "location_id": "057P5VYJ4A5X1",
    "line_items": [
      {
        "uid": "8uSwfzvUImn3IRrvciqlXC",
        "name": "Best API Doc platform",
        "quantity": "1",
        "applied_taxes": [
          {
            "uid": "aKG87ArnDpvMLSZJHxWUl",
            "tax_uid": "state-sales-tax",
            "applied_money": {
              "amount": 136,
              "currency": "USD"
            }
          }
        ],
        "applied_discounts": [
          {
            "uid": "jWdgP1TpHPFBuVrz81mXVC",
            "discount_uid": "membership-discount",
            "applied_money": {
              "amount": 8,
              "currency": "USD"
            }
          },
          {
            "uid": "jnZOjjVY57eRcQAVgEwFuC",
            "discount_uid": "labor-day-sale",
            "applied_money": {
              "amount": 79,
              "currency": "USD"
            }
          }
        ],
        "base_price_money": {
          "amount": 1599,
          "currency": "USD"
        },
        "gross_sales_money": {
          "amount": 1599,
          "currency": "USD"
        },
        "total_tax_money": {
          "amount": 136,
          "currency": "USD"
        },
        "total_discount_money": {
          "amount": 87,
          "currency": "USD"
        },
        "total_money": {
          "amount": 1648,
          "currency": "USD"
        },
        "variation_total_price_money": {
          "amount": 1599,
          "currency": "USD"
        }
      },
      {
        "uid": "v8ZuEXpOJpb0bazLuvrLDB",
        "name": "New York Steak",
        "quantity": "2",
        "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB",
        "variation_name": "Larger",
        "modifiers": [
          {
            "uid": "Lo3qMMckDluu9Qsb58d4CC",
            "catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ",
            "name": "Well",
            "base_price_money": {
              "amount": 50,
              "currency": "USD"
            },
            "total_price_money": {
              "amount": 100,
              "currency": "USD"
            }
          }
        ],
        "applied_taxes": [
          {
            "uid": "v1dAgrfUVUPTnVTf9sRPz",
            "tax_uid": "state-sales-tax",
            "applied_money": {
              "amount": 374,
              "currency": "USD"
            }
          }
        ],
        "applied_discounts": [
          {
            "uid": "nUXvdsIItfKko0dbYtY58C",
            "discount_uid": "membership-discount",
            "applied_money": {
              "amount": 22,
              "currency": "USD"
            }
          },
          {
            "uid": "qSdkOOOernlVQqsJ94SPjB",
            "discount_uid": "labor-day-sale",
            "applied_money": {
              "amount": 224,
              "currency": "USD"
            }
          },
          {
            "uid": "y7bVl4njrWAnfDwmz19izB",
            "discount_uid": "one-dollar-off",
            "applied_money": {
              "amount": 100,
              "currency": "USD"
            }
          }
        ],
        "base_price_money": {
          "amount": 2200,
          "currency": "USD"
        },
        "gross_sales_money": {
          "amount": 4500,
          "currency": "USD"
        },
        "total_tax_money": {
          "amount": 374,
          "currency": "USD"
        },
        "total_discount_money": {
          "amount": 346,
          "currency": "USD"
        },
        "total_money": {
          "amount": 4528,
          "currency": "USD"
        },
        "variation_total_price_money": {
          "amount": 4400,
          "currency": "USD"
        }
      }
    ],
    "taxes": [
      {
        "uid": "state-sales-tax",
        "name": "State Sales Tax",
        "type": "ADDITIVE",
        "percentage": "9",
        "applied_money": {
          "amount": 510,
          "currency": "USD"
        },
        "scope": "ORDER"
      }
    ],
    "discounts": [
      {
        "uid": "membership-discount",
        "catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7",
        "name": "Membership Discount",
        "type": "FIXED_PERCENTAGE",
        "percentage": "0.5",
        "applied_money": {
          "amount": 30,
          "currency": "USD"
        },
        "scope": "ORDER"
      },
      {
        "uid": "labor-day-sale",
        "name": "Labor Day Sale",
        "type": "FIXED_PERCENTAGE",
        "percentage": "5",
        "applied_money": {
          "amount": 303,
          "currency": "USD"
        },
        "scope": "ORDER"
      },
      {
        "uid": "one-dollar-off",
        "name": "Sale - $1.00 off",
        "type": "FIXED_AMOUNT",
        "amount_money": {
          "amount": 100,
          "currency": "USD"
        },
        "applied_money": {
          "amount": 100,
          "currency": "USD"
        },
        "scope": "LINE_ITEM"
      }
    ],
    "created_at": "2020-01-17T20:47:53.293Z",
    "updated_at": "2020-01-17T20:47:53.293Z",
    "state": "OPEN",
    "version": 1,
    "reference_id": "my-order-001",
    "total_money": {
      "amount": 6176,
      "currency": "USD"
    },
    "total_tax_money": {
      "amount": 510,
      "currency": "USD"
    },
    "total_discount_money": {
      "amount": 433,
      "currency": "USD"
    },
    "total_tip_money": {
      "amount": 0,
      "currency": "USD"
    },
    "total_service_charge_money": {
      "amount": 0,
      "currency": "USD"
    },
    "net_amounts": {
      "total_money": {
        "amount": 6176,
        "currency": "USD"
      },
      "tax_money": {
        "amount": 510,
        "currency": "USD"
      },
      "discount_money": {
        "amount": 433,
        "currency": "USD"
      },
      "tip_money": {
        "amount": 0,
        "currency": "USD"
      },
      "service_charge_money": {
        "amount": 0,
        "currency": "USD"
      }
    },
    "source": {
      "name": "My App"
    }
  }
}
Was this section helpful?

What made this section unhelpful for you?

Update order

Updates an open order by adding, replacing, or deleting fields.

Orders with a COMPLETED or CANCELED state cannot be updated.

An UpdateOrder request requires the following:

  • The order_id in the endpoint path, identifying the order to update.
  • The latest version of the order to update.
  • The sparse order containing only the fields to update and the version to which the update is being applied.
  • If deleting fields, the dot notation paths identifying the fields to clear.

Header Parameters

Authorizationstring
Content-Typestring

Path Parameters

order_idstring Required

Body Parameters

idempotency_keystring
orderobject

Show child attributes

fields_to_cleararray

Show child attributes

Response

200
Object

Response Attributes

orderobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

PUT

/v2/orders/{order_id}

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 curl --location --globoff --request PUT 'https://app.theneo.io/v2/orders/{order_id}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "idempotency_key": "UNIQUE_STRING", "order": { "version": 1, "line_items": [ { "uid": "cookie_uid", "quantity": "2", "name": "COOKIE", "base_price_money": { "amount": 200, "currency": "USD" } } ] }, "fields_to_clear": [ "discounts" ] }'

Response

{
  "order": {
    "version": 2,
    "total_money": {
      "currency": "USD",
      "amount": 900
    },
    "source": {
      "name": "Cookies"
    },
    "line_items": [
      {
        "total_tax_money": {
          "currency": "USD",
          "amount": 0
        },
        "total_money": {
          "amount": 500,
          "currency": "USD"
        },
        "gross_sales_money": {
          "amount": 500,
          "currency": "USD"
        },
        "base_price_money": {
          "amount": 500,
          "currency": "USD"
        },
        "quantity": "1",
        "total_discount_money": {
          "currency": "USD",
          "amount": 0
        },
        "name": "Small Coffee",
        "uid": "EuYkakhmu3ksHIds5Hiot",
        "variation_total_price_money": {
          "amount": 500,
          "currency": "USD"
        }
      },
      {
        "total_money": {
          "amount": 400,
          "currency": "USD"
        },
        "gross_sales_money": {
          "currency": "USD",
          "amount": 400
        },
        "total_tax_money": {
          "currency": "USD",
          "amount": 0
        },
        "variation_total_price_money": {
          "currency": "USD",
          "amount": 400
        },
        "name": "COOKIE",
        "uid": "cookie_uid",
        "base_price_money": {
          "amount": 200,
          "currency": "USD"
        },
        "quantity": "2",
        "total_discount_money": {
          "amount": 0,
          "currency": "USD"
        }
      }
    ],
    "state": "OPEN",
    "total_service_charge_money": {
      "amount": 0,
      "currency": "USD"
    },
    "id": "DREk7wJcyXNHqULq8JJ2iPAsluJZY",
    "location_id": "MXVQSVNDGN3C8",
    "total_tax_money": {
      "amount": 0,
      "currency": "USD"
    },
    "created_at": "2019-08-23T18:26:18.243Z",
    "total_discount_money": {
      "amount": 0,
      "currency": "USD"
    },
    "net_amounts": {
      "service_charge_money": {
        "currency": "USD",
        "amount": 0
      },
      "total_money": {
        "amount": 900,
        "currency": "USD"
      },
      "discount_money": {
        "currency": "USD",
        "amount": 0
      },
      "tax_money": {
        "currency": "USD",
        "amount": 0
      }
    },
    "updated_at": "2019-08-23T18:33:47.523Z"
  }
}
Was this section helpful?

What made this section unhelpful for you?

Retrieve order

Retrieves an Order by ID.

Header Parameters

Authorizationstring
Content-Typestring

Path Parameters

order_idstring Required

Response

200
Object

Response Attributes

orderobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/v2/orders/{order_id}

Select
1 2 3 curl --location --globoff 'https://app.theneo.io/v2/orders/{order_id}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'Content-Type: application/json'

Response

{
  "order": {
    "id": "CAISENgvlJ6jLWAzERDzjyHVybY",
    "location_id": "D7AVYMEAPJ3A3",
    "line_items": [
      {
        "uid": "ULkg0tQTRK2bkU9fNv3IJD",
        "quantity": "1",
        "name": "Item 1",
        "base_price_money": {
          "amount": 500,
          "currency": "USD"
        },
        "gross_sales_money": {
          "amount": 500,
          "currency": "USD"
        },
        "total_tax_money": {
          "amount": 0,
          "currency": "USD"
        },
        "total_discount_money": {
          "amount": 250,
          "currency": "USD"
        },
        "total_money": {
          "amount": 250,
          "currency": "USD"
        },
        "variation_total_price_money": {
          "amount": 500,
          "currency": "USD"
        },
        "applied_discounts": [
          {
            "uid": "9zr9S4dxvPAixvn0lpa1VC",
            "discount_uid": "zGsRZP69aqSSR9lq9euSPB",
            "applied_money": {
              "amount": 250,
              "currency": "USD"
            }
          }
        ]
      },
      {
        "uid": "mumY8Nun4BC5aKe2yyx5a",
        "quantity": "2",
        "name": "Item 2",
        "base_price_money": {
          "amount": 300,
          "currency": "USD"
        },
        "gross_sales_money": {
          "amount": 600,
          "currency": "USD"
        },
        "total_tax_money": {
          "amount": 0,
          "currency": "USD"
        },
        "total_discount_money": {
          "amount": 300,
          "currency": "USD"
        },
        "total_money": {
          "amount": 300,
          "currency": "USD"
        },
        "variation_total_price_money": {
          "amount": 600,
          "currency": "USD"
        },
        "applied_discounts": [
          {
            "uid": "qa8LwwZK82FgSEkQc2HYVC",
            "discount_uid": "zGsRZP69aqSSR9lq9euSPB",
            "applied_money": {
              "amount": 300,
              "currency": "USD"
            }
          }
        ]
      }
    ],
    "discounts": [
      {
        "uid": "zGsRZP69aqSSR9lq9euSPB",
        "name": "50% Off",
        "percentage": "50",
        "applied_money": {
          "amount": 550,
          "currency": "USD"
        },
        "type": "FIXED_PERCENTAGE",
        "scope": "ORDER"
      }
    ],
    "created_at": "2020-05-18T16:30:49.614Z",
    "updated_at": "2020-05-18T16:30:49.614Z",
    "state": "OPEN",
    "version": 1,
    "total_tax_money": {
      "amount": 0,
      "currency": "USD"
    },
    "total_discount_money": {
      "amount": 550,
      "currency": "USD"
    },
    "total_tip_money": {
      "amount": 0,
      "currency": "USD"
    },
    "total_money": {
      "amount": 550,
      "currency": "USD"
    },
    "total_service_charge_money": {
      "amount": 0,
      "currency": "USD"
    },
    "net_amounts": {
      "total_money": {
        "amount": 550,
        "currency": "USD"
      },
      "tax_money": {
        "amount": 0,
        "currency": "USD"
      },
      "discount_money": {
        "amount": 550,
        "currency": "USD"
      },
      "tip_money": {
        "amount": 0,
        "currency": "USD"
      },
      "service_charge_money": {
        "amount": 0,
        "currency": "USD"
      }
    }
  }
}
Was this section helpful?

What made this section unhelpful for you?

Create subscription

Creates a subscription to a subscription plan by a customer.

If a card on file is provided in the request, the API provider will charge the card for the subscription. Otherwise, an email invoice is sent to the customer. The subscription begins instantly unless the optional start date parameter is included in the request. Each unique subscription corresponds to a certain region.

Header Parameters

Authorizationstring
Content-Typestring

Body Parameters

idempotency_keystring
location_idstring
plan_idstring
customer_idstring
card_idstring
start_datestring
tax_percentagestring
price_override_moneyobject

Show child attributes

timezonestring
sourceobject

Show child attributes

Response

200
Object

Response Attributes

subscriptionobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/v2/subscriptions

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 curl --location 'https://app.theneo.io/v2/subscriptions' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "idempotency_key": "8193148c-9586-11e6-99f9-28cfe92138cf", "location_id": "S8GWD5R9QB376", "plan_id": "6JHXF3B2CW3YKHDV4XEM674H", "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G", "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB", "start_date": "2021-10-20", "tax_percentage": "5", "price_override_money": { "amount": 100, "currency": "USD" }, "timezone": "America/Los_Angeles", "source": { "name": "My App" } }'

Response

{
  "subscription": {
    "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f",
    "location_id": "S8GWD5R9QB376",
    "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
    "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
    "start_date": "2021-10-20",
    "status": "PENDING",
    "tax_percentage": "5",
    "price_override_money": {
      "amount": 100,
      "currency": "USD"
    },
    "version": 1594155459464,
    "created_at": "2021-10-20T21:53:10Z",
    "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
    "timezone": "America/Los_Angeles",
    "source": {
      "name": "My App"
    }
  }
}
Was this section helpful?

What made this section unhelpful for you?

Search subscriptions

Searches for subscriptions.

Results are ordered chronologically by subscription creation date. If the request specifies more than one location ID, the endpoint orders the result by location ID, and then by creation date within each location. If no locations are given in the query, all locations are searched.

You can also optionally specify customer_ids to search by customer. If left unset, all customers associated with the specified locations are returned. If the request specifies customer IDs, the endpoint orders results first by location, within location by customer ID, and within customer by subscription creation date.

Header Parameters

Authorizationstring
Content-Typestring

Body Parameters

queryobject

Show child attributes

Response

200
Object

Response Attributes

subscriptionsarray

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/v2/subscriptions/search

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 curl --location 'https://app.theneo.io/v2/subscriptions/search' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "query": { "filter": { "location_ids": [ "S8GWD5R9QB376" ], "customer_ids": [ "CHFGVKYY8RSV93M5KCYTG4PN0G" ], "source_names": [ "My App" ] } } }'

Response

{
  "subscriptions": [
    {
      "id": "de86fc96-8664-474b-af1a-abbe59cacf0e",
      "location_id": "S8GWD5R9QB376",
      "plan_id": "L3TJVDHVBEQEGQDEZL2JJM7R",
      "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
      "start_date": "2021-10-20",
      "canceled_date": "2021-10-20",
      "charged_through_date": "2021-11-20",
      "status": "CANCELED",
      "created_at": "2021-10-20T21:53:10Z",
      "card_id": "ccof:mueUsvgajChmjEbp4GB",
      "paid_until_date": "2021-11-20",
      "timezone": "UTC",
      "source": {
        "name": "My Application"
      }
    },
    {
      "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f",
      "location_id": "S8GWD5R9QB376",
      "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
      "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
      "start_date": "2021-10-20",
      "status": "PENDING",
      "tax_percentage": "5",
      "price_override_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "version": 1594155459464,
      "created_at": "2021-10-20T21:53:10Z",
      "timezone": "America/Los_Angeles",
      "source": {
        "name": "My Application"
      }
    },
    {
      "id": "8151fc89-da15-4eb9-a685-1a70883cebfc",
      "location_id": "S8GWD5R9QB376",
      "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
      "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
      "start_date": "2021-10-20",
      "charged_through_date": "2021-11-20",
      "status": "ACTIVE",
      "invoice_ids": [
        "grebK0Q_l8H4fqoMMVvt-Q",
        "rcX_i3sNmHTGKhI4W2mceA"
      ],
      "price_override_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "created_at": "2021-10-20T21:53:10Z",
      "paid_until_date": "2021-11-20",
      "timezone": "America/Los_Angeles",
      "source": {
        "name": "My Application"
      }
    }
  ]
}
Was this section helpful?

What made this section unhelpful for you?

Update subscription

Updates a subscription.

You can set, modify, and clear the subscription field values.

Header Parameters

Authorizationstring
Content-Typestring

Path Parameters

subscription_idstring Required

Body Parameters

subscriptionobject

Show child attributes

Response

200
Object

Response Attributes

subscriptionobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

PUT

/v2/subscriptions/{subscription_id}

Select
1 2 3 4 5 6 7 8 9 10 11 12 13 curl --location --globoff --request PUT 'https://app.theneo.io/v2/subscriptions/{subscription_id}' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "subscription": { "version": 1594155459464, "tax_percentage": {}, "price_override_money": { "amount": 2000, "currency": "USD" } } }'

Response

{
  "subscription": {
    "id": "9ba40961-995a-4a3d-8c53-048c40cafc13",
    "location_id": "S8GWD5R9QB376",
    "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
    "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
    "status": "ACTIVE",
    "price_override_money": {
      "amount": 2000,
      "currency": "USD"
    },
    "version": 1594311617331,
    "created_at": "2021-10-20T21:53:10Z",
    "timezone": "America/Los_Angeles",
    "source": {
      "name": "My App"
    }
  }
}
Was this section helpful?

What made this section unhelpful for you?

Cancel subscription

Schedules a CANCEL action to cancel an active subscription by setting the canceled_date field to the end of the active billing period and changing the subscription status from ACTIVE to CANCELED after this date.

Header Parameters

Authorizationstring
Content-Typestring

Path Parameters

subscription_idstring Required

Response

200
Object

Response Attributes

subscriptionobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/v2/subscriptions/{subscription_id}/cancel

Select
1 2 3 curl --location --globoff --request POST 'https://app.theneo.io/v2/subscriptions/{subscription_id}/cancel' \ --header 'Authorization: Bearer ACCESS_TOKEN' \ --header 'Content-Type: application/json'

Response

{
  "subscription": {
    "id": "910afd30-464a-4e00-a8d8-2296eEXAMPLE",
    "location_id": "S8GWD5R9QB376",
    "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
    "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
    "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
    "start_date": "2021-10-20",
    "canceled_date": "2021-10-20",
    "paid_until_date": "2021-11-20",
    "status": "ACTIVE",
    "created_at": "2021-10-20T21:53:10Z",
    "version": 1594311617331,
    "timezone": "America/Los_Angeles",
    "source": {
      "name": "My App"
    }
  }
}
Was this section helpful?

What made this section unhelpful for you?

Hr Management Examples

Leverage all these API to build your own in-app payroll solution, customized for your users' needs

How Are APIs Used By HR Software Providers?

Back in the bad old days before software that's hosted in the Cloud became the norm, APIs were designed to make it possible to connect different legacy software systems, which were often hosted on-premise (within the business location itself). Today, the ways in which APIs are applied is growing exponentially. Organisations with complex digital infrastructures use them to simplify data transfer. HR and ERP software providers use them to integrate seamlessly with other systems like Payroll and Time & Attendance. APIs facilitate data transfers that reduce the manual handling, time, and cost involved in importing and exporting (sharing) data.  

In combination with automated data validation (to check the accuracy and completeness of data that is uploaded to the system), the integrations between HR, Payroll and T&A solutions reduce processing times, decrease error rates, and eliminate the need for data double entry. Essentially, integrations are all about efficiency. They save you time, money, and energy.

APIs as HR and Payroll Software Enhancers

Most HR software Platforms provide APIs that you can use to integrate, automate, and orchestrate data sharing without writing code. In the HR and Payroll spaces, APIs make it easier to integrate and connect systems, services and data, create new user experiences, share information, and authenticate users. They enable transactions and algorithms and let you offer new services.

Using APIs, you can turn your HR software Platform into the source of truth in a digital ecosystem. With the right integrations, your HR Platform forms the hub in a spoke and wheel type configuration for real-time data sharing and improved decision-making across your entire organisation. Another benefit of using an HR HR software Platform (as opposed to stand-alone HR solutions) with a high number of out-of-the-box integrations and an open API is that you will also be less dependent on any one vendor for managing the processes and tasks your business needs to digitise, automate and optimise. If you don’t like that particular product or service at some point in the future, or a better one becomes available, you can simply switch out one solution in your ecosystem for another via the API.

When you access pre-existing integrations through the vendor API instead of having new ones built (which might require the time and cost of a Developer), you save your business time and money. Here's an estimate of what it costs to build a custom API from scratch:

“An enterprise API costs an estimated $25,000-$30,000 to build, and then 50% of that amount per year to manage. Multiply that by 10 APIs and you have $275,000-$450,000 per year just so APIs can exist within your organisation. Everyone who wants to access an API must develop, test and implement custom code, at an estimated cost of $15,000 per integration, plus a 50% maintenance fee. Each API must also be secured, costing additional thousands of dollars.” 

No matter how sophisticated your HR solution (or suite of solutions) is, it will never cover all of the services you need or want to offer to your employees. Sometimes it will be necessary to exchange data with another service. Payroll is an excellent example. Or, you might want to make a completely new service available and that vendor only offers it through an API. APIs also happen to make life easier for your employees - if your HR software provider offers single sign-on, that means you can combine access to all the different software products you use via a single logon - meaning you give your people one place to go and help themselves to al the different business systems they need.

Endpoints

POST
DELETE
GET
PUT
POST
PATCH
DELETE
POST