{ "openapi": "3.0.0", "info": { "description": "The FastSpring API and its supported requests, data, endpoints, and rate limits.\n\nThe FastSpring API is a backend service you can use to communicate with your FastSpring Store programmatically. It requires basic understanding of HTTP communication methods. The primary API communication methods include:\n- **GET** - request data from your store\n- **POST** - send data to your store, such as creating a new product record\n- **DELETE** - remove data from your store\n\nThe structure of the JSON data sent and received using the API is very similar to Webhooks. However, using the FastSpring API, you initiate all communication with your FastSpring Store.\n\nIf you prefer a client-side method of communicating with your FastSpring Store and generating dynamic webpage content, check out the [Store Builder Library](https://fastspring.com/docs/get-started-with-store-builder-library/).\n\n## Access the API\n\n#### API Credentials and Authentication\n\nFastSpring API credentials consist of a single username and password for your entire Store. The username and password are used for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) when making requests to the API.\n\n#### Obtain Your API Credentials\n\n1. Log on to the FastSpring App and navigate to [Integrations](https://fastspring.com/docs/integrations) > **API Credentials**. Initially, the only option on this page is the **Create** command.\n\n2. Click **Create** to generate your API **Username** and **Password**. The page automatically refreshes, and then your credentials are displayed.\n\n3. Make a note of the credentials and store them securely.\n\nThe API credentials allow complete access and control over your FastSpring Store. You will not be able to view the password in the FastSpring App after this session. If you forget your API credentials, you can reset them, however any of your stored procedures that rely on API access must be updated immediately with the new credentials. Otherwise, the API requests will fail.\n\n## API Requests\n\n**Make all requests to https://api.fastspring.com**\n\nWhen you make your requests, consider the following:\n- Ensure that the HTTP methods for all calls use uppercase letters (“GET,” “POST,” “DELETE”) Lowercase letters may result in a 404 error response.\n- FastSpring requires TLS 1.2 (or later) encryption for all calls to the FastSpring API. \n- The API requires a **User-Agent** header in all requests. If your request does not include it, you may receive an 401 error message when attempting to make API requests.\n- The API uses basic authentication and does not support URL-encoded authentication. Use **Base64** to encode your username and password in the header.\n", "version": "1.0", "title": "FastSpring API", "contact": {} }, "paths": { "/accounts/{account_id}": { "get": { "summary": "Get an account", "tags": [ "Accounts" ], "operationId": "Getoneaccount", "deprecated": false, "parameters": [ { "name": "account_id", "in": "path", "required": true, "description": "Account Id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOneAccount" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOneAccountError" } } } } } }, "post": { "summary": "Update account", "tags": [ "Accounts" ], "operationId": "Updateexistingaccount", "deprecated": false, "parameters": [ { "name": "account_id", "in": "path", "required": true, "description": "Account Id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOneAccount" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOneAccountResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOneAccountError" } } } } } } }, "/accounts/{account_id}/authenticate": { "get": { "summary": "Get authenticated account management URL", "tags": [ "Accounts" ], "operationId": "GetauthenticatedaccountmanagementURL", "deprecated": false, "parameters": [ { "name": "account_id", "in": "path", "required": true, "description": "Account Id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateAccount" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateAccountError" } } } } } } }, "/accounts": { "post": { "summary": "Create an account", "tags": [ "Accounts" ], "operationId": "Createanaccount", "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOneAccount" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOneAccountResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOneAccountError" } } } } } }, "get": { "summary": "Get all accounts or Search for accounts by parameter", "tags": [ "Accounts" ], "description": "If no parameters are sent, the operation will return a list of accountIDs.", "operationId": "LookUpAccountsbyParameters", "deprecated": false, "parameters": [ { "name": "email", "in": "query", "description": "Account email", "schema": { "type": "string" } }, { "name": "custom", "in": "query", "description": "Account custom key", "schema": { "type": "string" } }, { "name": "global", "in": "query", "description": "Account global key", "schema": { "type": "string" } }, { "name": "orderID", "in": "query", "description": "Order id", "schema": { "type": "string" } }, { "name": "orderReference", "in": "query", "description": "Order Reference", "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "query", "description": "Subscription ID", "schema": { "type": "string" } }, { "name": "products", "in": "query", "description": "Product ID", "schema": { "type": "string" } }, { "name": "subscriptions", "in": "query", "description": "\"active\", \"ended\", \"canceled\", \"started\" will return accounts with subscriptions in the corresponding state", "schema": { "type": "string" } }, { "name": "refunds", "in": "query", "description": "true", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "integer value indicating the maximum number of records to be returned Or, when used together with page, the maximum number of records to be returned per page", "schema": { "type": "number" } }, { "name": "page", "in": "query", "description": "Integer value that must be used in conjunction with limit to specify which page of results should be returned", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/LookUpAccount" }, { "$ref": "#/components/schemas/GetAllAccounts" } ] } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookUpAccountError" } } } } } } }, "/coupons": { "post": { "summary": "Create a coupon", "tags": [ "Coupons" ], "operationId": "Createanewcoupon", "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateanewcouponRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } } } }, "/coupons/{coupon_id}": { "post": { "summary": "Assign codes to a coupon", "tags": [ "Coupons" ], "operationId": "Addcouponcodestoacoupon", "deprecated": false, "parameters": [ { "name": "coupon_id", "in": "path", "required": true, "description": "Coupon Id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddcouponcodestoacouponRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } } }, "get": { "summary": "Retrieve coupon details", "tags": [ "Coupons" ], "operationId": "Retrievecoupondetails", "deprecated": false, "parameters": [ { "name": "coupon_id", "in": "path", "required": true, "description": "Coupon Id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCouponsDetailsResponse" } } } } } } }, "/coupons/{coupon_id}/codes": { "get": { "summary": "Get coupon codes assigned to a coupon", "tags": [ "Coupons" ], "operationId": "Getcouponcodesassignedtoacoupon", "deprecated": false, "parameters": [ { "name": "coupon_id", "in": "path", "required": true, "description": "Coupon Id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCouponCodesRequest" } } } }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCouponCodesResponse" } } } } } }, "delete": { "summary": "Delete all codes associated with a coupon", "tags": [ "Coupons" ], "operationId": "Deleteallcouponcodesfromacoupon", "deprecated": false, "parameters": [ { "name": "coupon_id", "in": "path", "required": true, "description": "Coupon Id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} } } } }, "/events/processed": { "get": { "summary": "Get processed events", "tags": [ "Events" ], "operationId": "Getprocessedevents", "deprecated": false, "parameters": [ { "name": "days", "in": "query", "required": true, "description": "", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEventsResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEventsResponseBad" } } } } } } }, "/events/unprocessed": { "get": { "summary": "Get unprocessed events", "tags": [ "Events" ], "operationId": "Getunprocessedevents", "deprecated": false, "parameters": [ { "name": "begin", "in": "query", "required": true, "description": "", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEventsResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEventsResponseBad" } } } } } } }, "/events/{event_id}": { "post": { "summary": "Update an event", "tags": [ "Events" ], "operationId": "Updateasingleevent", "deprecated": false, "parameters": [ { "name": "event_id", "in": "path", "required": true, "description": "Event Id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateasingleeventRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } } } }, "/orders/{order_id}": { "get": { "summary": "Get orders by ID", "tags": [ "Orders" ], "operationId": "GetordersbyID", "deprecated": false, "parameters": [ { "name": "order_id", "in": "path", "required": true, "description": "Order Id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrdersById" } } } }, "400": { "description": "Bad request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrdersByIdError" } } } } } } }, "/orders?products={product_path}&limit={limit}&page={page}": { "get": { "summary": "Get orders by product path", "tags": [ "Orders" ], "operationId": "Getordersbyproductpath", "deprecated": false, "parameters": [ { "name": "product_path", "in": "path", "required": true, "description": "Product path", "schema": { "type": "string" } }, { "name": "limit", "in": "path", "required": true, "description": "integer limits the number of order records returned per page (default is 50 records)", "schema": { "type": "number" } }, { "name": "page", "in": "path", "required": true, "description": "specifies page number of results to be returned; used together with limit to control pagination", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrdersByProductPath" } } } } } } }, "/orders?begin={begin_date}&end={end_date}&limit={limit}&page={page}": { "get": { "summary": "Get orders by date range", "tags": [ "Orders" ], "operationId": "Getordersbydaterange", "deprecated": false, "parameters": [ { "name": "begin_date", "in": "path", "required": true, "description": "filters results to include transactions after the specified begin date (must be at least one day before the specified end date), the format must be MM/DD/YY", "schema": { "type": "string" } }, { "name": "end_date", "in": "path", "required": true, "description": "filters results to include transactions before the specified end date, the format must be MM/DD/YY", "schema": { "type": "string" } }, { "name": "limit", "in": "path", "required": true, "description": "integer limits the number of order records returned per page (default is 50 records)", "schema": { "type": "number" } }, { "name": "page", "in": "path", "required": true, "description": "specifies page number of results to be returned; used together with limit to control pagination", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrdersByDates" } } } }, "400": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrdersByDatesError" } } } } } } }, "/orders?products={product_path}&begin={begin_date}&end={end_date}": { "get": { "summary": "Get orders by product path AND date range", "tags": [ "Orders" ], "operationId": "Getordersbyproductdaterange", "deprecated": false, "parameters": [ { "name": "product_path", "in": "path", "required": true, "description": "Product path", "schema": { "type": "string" } }, { "name": "begin_date", "in": "path", "required": true, "description": "filters results to include transactions after the specified begin date (must be at least one day before the specified end date), the format must be yyyy-mm-dd", "schema": { "type": "string" } }, { "name": "end_date", "in": "path", "required": true, "description": "filters results to include transactions before the specified end date, the format must be yyyy-mm-dd", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "integer limits the number of order records returned per page (default is 50 records)", "schema": { "type": "number" } }, { "name": "page", "in": "query", "description": "specifies page number of results to be returned; used together with limit to control pagination", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrdersByProductPathDates" } } } } } } }, "/orders?end={end_date}": { "get": { "summary": "Get orders by end date", "tags": [ "Orders" ], "operationId": "Getordersbyenddate", "deprecated": false, "parameters": [ { "name": "end_date", "in": "path", "required": true, "description": "filters results to include transactions before the specified end date, the format must be MM/DD/YY", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrdersByEndDate" } } } } } } }, "/orders?begin={begin_date}&end={end_date}&returns={return}": { "get": { "summary": "Get orders with returns only", "tags": [ "Orders" ], "operationId": "Getordersbyreturn", "deprecated": false, "parameters": [ { "name": "begin_date", "in": "path", "required": true, "description": "filters results to include transactions after the specified begin date (must be at least one day before the specified end date), the format must be MM/DD/YY", "schema": { "type": "string" } }, { "name": "end_date", "in": "path", "required": true, "description": "filters results to include transactions before the specified end date, the format must be MM/DD/YY", "schema": { "type": "string" } }, { "name": "return", "in": "path", "required": true, "description": "", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrdersWithReturnOnly" } } } } } } }, "/orders": { "post": { "summary": "Update order tags and attributes", "tags": [ "Orders" ], "operationId": "updateordertagsandattributes", "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderTags" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UpdateOrderTagsResponse" }, { "$ref": "#/components/schemas/UpdateOrderTagsResponse2" } ] } } } } } } }, "/products/{product_path}": { "get": { "summary": "Get products by path", "tags": [ "Products" ], "operationId": "Getproductsbyid", "deprecated": false, "parameters": [ { "name": "product_path", "in": "path", "required": true, "description": "Product path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductsByPth" } } } } } } }, "/products": { "get": { "summary": "Get all product IDs", "tags": [ "Products" ], "operationId": "Getlistofallproductids", "deprecated": false, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllProducts" } } } } } }, "post": { "summary": "Create and update products", "tags": [ "Products" ], "operationId": "Createoneormorenewproducts", "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateoneormorenewproductsRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UpdateProductsResponse" }, { "$ref": "#/components/schemas/CreateProductsResponse" } ] } } } }, "201": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductsResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductsResponseError" } } } } } } }, "/products/offers/{product_path}": { "get": { "summary": "Get all offers for a product by offer type", "tags": [ "Products" ], "operationId": "Getalloffersforproductbyoffertype", "deprecated": false, "parameters": [ { "name": "product_path", "in": "path", "required": true, "description": "Product path", "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "description": "Offer Type", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllOffersforProductByOfferTypeSuccessResponse" } } } } } }, "post": { "summary": "Create or Update Product offers", "tags": [ "Products" ], "operationId": "Createorupdateproductoffers", "deprecated": false, "parameters": [ { "name": "product_path", "in": "path", "required": true, "description": "Product path", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateorupdateProductOffersRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateProductOffersResponse" }, { "$ref": "#/components/schemas/UpdateProductOffersResponse" } ] } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateorupdateProductOffersError" } } } } } } }, "/products/price": { "get": { "summary": "Get all product prices", "tags": [ "Products" ], "operationId": "Getallproductsprice", "deprecated": false, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllProductsPrice" } } } } } } }, "/products/price/{id}": { "get": { "summary": "Get a product price", "tags": [ "Products" ], "operationId": "Getspecificproductprice", "deprecated": false, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Product Id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductPrice" } } } } } } }, "/products/price?country={country}": { "get": { "summary": "Get all product prices in specified country", "tags": [ "Products" ], "operationId": "Getallproductspricewithcountry", "deprecated": false, "parameters": [ { "name": "country", "in": "path", "required": true, "description": "Country code", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllProductsPrice" } } } } } } }, "/products/price?country={country}¤cy={currency}": { "get": { "summary": "Get all product prices in specified country and currency", "tags": [ "Products" ], "operationId": "Getallproductspricewithcountryandcurrency", "deprecated": false, "parameters": [ { "name": "country", "in": "path", "required": true, "description": "Country code", "schema": { "type": "string" } }, { "name": "currency", "in": "path", "required": true, "description": "Currency code", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllProductsPrice" } } } } } } }, "/products/price/{id}?country={country}¤cy={currency}": { "get": { "summary": "Get a product price in a specified country and currency", "tags": [ "Products" ], "operationId": "Getspecificproductpricecountrycurrency", "deprecated": false, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Product Id", "schema": { "type": "string" } }, { "name": "country", "in": "path", "required": true, "description": "Country code", "schema": { "type": "string" } }, { "name": "currency", "in": "path", "required": true, "description": "currency code", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductPrice" } } } } } } }, "/products/price/{id}?country={country}": { "get": { "summary": "Get a product price in a specified country", "tags": [ "Products" ], "operationId": "Getspecificproductpricecountry", "deprecated": false, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Product Id", "schema": { "type": "string" } }, { "name": "country", "in": "path", "required": true, "description": "country code", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductPrice" } } } } } } }, "/products/{id}": { "delete": { "summary": "Delete products", "tags": [ "Products" ], "operationId": "DeleteProducts", "deprecated": false, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Product Id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteProductsResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteProductsResponseBad" } } } } } } }, "/returns/{id}": { "get": { "summary": "Get returns", "tags": [ "Returns" ], "operationId": "Getoneormultiplereturns", "deprecated": false, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetReturnsResponse" } } } } } } }, "/returns": { "post": { "summary": "Create returns", "tags": [ "Returns" ], "operationId": "PostOneMoreOrdersReturns", "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostReturnsRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostReturnsResponse" } } } } } } }, "/sessions": { "post": { "summary": "Create a session", "tags": [ "Sessions" ], "operationId": "Createasessionwithoutoverridinganydefaultvalues", "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateasessionwithoutoverridinganydefaultvaluesRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostSessionsResponse" } } } }, "400": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostSessionsResponseBad" } } } } } } }, "/subscriptions": { "get": { "summary": "Get all subscriptions", "tags": [ "Subscriptions" ], "operationId": "Getallsubscriptioninstances", "deprecated": false, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllSubscriptionsInstancesResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionGetErrorResponse" } } } } } }, "post": { "summary": "Update a subscription", "tags": [ "Subscriptions" ], "operationId": "Changetheproductforanactivesubscription", "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangetheproductforanactivesubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeProductResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeProductResponseBad" } } } } } } }, "/subscriptions/estimate": { "post": { "summary": "Preview a proposed prorated plan change", "tags": [ "Subscriptions" ], "operationId": "SubscriptoinProratePreviewEstimate", "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateSubscriptionSuccessResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateSubscriptionErrorResponse" } } } } } } }, "/subscriptions/{subscription_id}": { "get": { "summary": "Get a subscription", "tags": [ "Subscriptions" ], "operationId": "Getoneormoresubscriptioninstances", "deprecated": false, "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "description": "Subscription Id", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "description": "specify a specific customer account whose subscriptions you want to retrieve", "schema": { "type": "string" } }, { "name": "begin", "in": "query", "description": "specify the beginning of a date range in yyyy-mm-dd-format", "schema": { "type": "string" } }, { "name": "end", "in": "query", "description": "specify the end of a date range in yyyy-mm-dd format", "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "In each event, use begin and end to retrieve the corresponding subscriptions", "schema": { "type": "string" } }, { "name": "products", "in": "query", "description": "enter one or more product ids to filter the response to include only subscriptions for the specified products; use commas to separate multiple values", "schema": { "type": "string" } }, { "name": "scope", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetASubscriptionResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionGetErrorResponse" } } } } } }, "delete": { "summary": "Cancel a subscription", "tags": [ "Subscriptions" ], "operationId": "Cancelsubscriptioninstances", "deprecated": false, "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "description": "Subscription Id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelSubscriptionResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCancelErrorResponse" } } } } } }, "post": { "summary": "Resume a canceled subscription", "tags": [ "Subscriptions" ], "operationId": "Uncancelasubscriptionpriortodeactivation", "deprecated": false, "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "description": "Subscription Id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UncancelasubscriptionpriortodeactivationRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionGetErrorResponse" } } } } } } }, "/subscriptions/{subscription_id}/entries": { "get": { "summary": "Get subscription entries", "tags": [ "Subscriptions" ], "operationId": "Getsubscriptioninstanceentries", "deprecated": false, "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "description": "Subscription Id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "headers": {} }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionGetErrorResponse" } } } } } } }, "/subscriptions/charge": { "post": { "summary": "Rebill a managed subscription", "tags": [ "Subscriptions" ], "operationId": "Rebillmanagedsubscriptioninstance", "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeSubscriptionResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionChargeErrorResponse" } } } } } } }, "/subscriptions/{subscription_id}/pause": { "post": { "summary": "Pause a subscription", "tags": [ "Subscriptions" ], "operationId": "Pauseasubscription", "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "description": "Subscription Id", "schema": { "type": "string" } } ], "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PauseSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PauseSubscriptionResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PauseSubscriptionErrorResponse" } } } } } } }, "/subscriptions/{subscription_id}/resume": { "post": { "summary": "Remove a scheduled pause", "tags": [ "Subscriptions" ], "operationId": "resumeapausedsubscription", "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "description": "Subscription Id", "schema": { "type": "string" } } ], "deprecated": false, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetASubscriptionResponse" } } } }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumeSubscriptionErrorResponse" } } } } } } }, "/subscriptions/{subscription_id}/convert": { "post": { "summary": "Convert an Expired Trial Subscription without a Payment Method", "tags": [ "Subscriptions" ], "operationId": "ConvertExpiredTrialWithoutPaymentMethod", "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "description": "Subscription Id", "schema": { "type": "string" } } ], "deprecated": false, "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertExpiredTrialWithoutPaymentMethodResponse" } } } }, "400": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertExpiredTrialWithoutPaymentMethodErrorResponse" } } } } } } }, "/subscriptions/{subscription_id}/history": { "get": { "summary": "Get subscription plan change history", "tags": [ "Subscriptions" ], "operationId": "GetsubscriptionplanC=changehistory", "deprecated": false, "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "description": "Subscription Id", "schema": { "type": "string" } }, { "name": "scope", "in": "query", "required": false, "description": "Type of items to return", "schema": { "type": "string", "enum": [ "base_plan", "add_on" ] } }, { "name": "order", "in": "query", "required": false, "description": "Sort Order for the results", "schema": { "type": "string", "enum": [ "increasing", "decreasing" ] } } ], "responses": { "200": { "description": "", "headers": {} }, "500": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionGetErrorResponse" } } } } } } }, "/quotes/{id}": { "get": { "summary": "Get a quote", "tags": [ "Quotes" ], "operationId": "getQuoteById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/QuoteResponse" } } } } } }, "put": { "summary": "Update a quote", "tags": [ "Quotes" ], "operationId": "updateQuote", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "A unique identifier for the quote", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "updateQuoteRequest": { "$ref": "#/components/schemas/UpdateQuoteRequest" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/QuoteResponse" } } } } } }, "delete": { "summary": "Delete a quote", "tags": [ "Quotes" ], "operationId": "deleteQuote", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "A unique identifier for the quote", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/QuoteResponse" } } } } } } }, "/quotes/{id}/cancel": { "post": { "summary": "Cancel a quote", "tags": [ "Quotes" ], "operationId": "cancelQuote", "parameters": [ { "name": "id", "in": "path", "description": "A unique identifier for the quote", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/QuoteResponse" } } } } } } }, "/quotes": { "get": { "summary": "Get all quotes", "tags": [ "Quotes" ], "operationId": "getAllQuotes", "parameters": [ { "name": "createdBegin", "in": "query", "description": "The format must be YYYY-MM-DD", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "createdEnd", "in": "query", "description": "The format must be YYYY-MM-DD", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "createdEmail", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "expiresBegin", "in": "query", "description": "The format must be YYYY-MM-DD", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "expiresEnd", "in": "query", "description": "The format must be YYYY-MM-DD", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "searchParam", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "expiredBefore", "in": "query", "description": "The format must be YYYY-MM-DD", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "onlyQuoteId", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "statuses", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CollectionModelQuoteResponse" } } } } } }, "post": { "summary": "Create a quote", "tags": [ "Quotes" ], "operationId": "createQuote", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateQuoteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteResponse" } } } } } } }, "/webhooks/keys": { "post": { "summary": "Update a webhook key secret", "operationId": "rotateWebhookKey", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "url", "hmacSecret" ], "properties": { "url": { "type": "string", "format": "uri", "description": "The URL associated with the webhook." }, "hmacSecret": { "type": "string", "description": "The new HMAC Secret key.", "maxLength": 100 } } } } } }, "responses": { "200": { "description": "Successful key rotation", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "action": { "type": "string", "example": "webhooks.update" }, "result": { "type": "string", "example": "success" } } } } } }, "400": { "description": "Bad request due to validation errors", "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "example": "webhooks.update" }, "result": { "type": "string", "example": "error" }, "error": { "type": "object", "properties": { "url": { "type": "string", "example": "A URL is required" }, "hmacSecret": { "oneOf": [ { "type": "string", "example": "A HMAC Secret is required" }, { "type": "string", "example": "Maximum length exceeded. The HMAC Secret must be no longer than 100 characters long." } ] } } } } } } } } } } }, "/data/v1/subscription": { "post": { "summary": "Generates a subscription report", "tags": [ "Data" ], "operationId": "GenerateSubscriptionReport", "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSubscriptionReportRequest" } } }, "required": true }, "responses": { "200": { "description": "Subscription response", "headers": {}, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PostSubscriptionSyncResponse" }, { "$ref": "#/components/schemas/PostSubscriptionAsyncResponse" } ] } } } }, "400": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostSubscriptionResponseBad" } } } } } } }, "/data/v1/revenue": { "post": { "summary": "Generates a revenue report", "tags": [ "Data" ], "operationId": "GenerateRevenueReport", "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateRevenueReportRequest" } } }, "required": true }, "responses": { "200": { "description": "Revenue response", "headers": {}, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PostRevenueSyncResponse" }, { "$ref": "#/components/schemas/PostRevenueAsyncResponse" } ] } } } }, "400": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostRevenueResponseBad" } } } } } } }, "/data/v1/jobs/{id}": { "get": { "summary": "Get job information based on a job ID.", "tags": [ "Data" ], "operationId": "getJobById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetJobIdResponse" } } } }, "400": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetJobIdResponseBad" } } } } } } }, "/data/v1/jobs": { "get": { "summary": "Get information from a job listing.", "tags": [ "Data" ], "operationId": "getJobs", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetJobsResponse" } } } } } } }, "/data/v1/util/cache": { "get": { "summary": "Reset cache for data service end points.", "tags": [ "Data" ], "operationId": "resetCache", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "example": "Cache reset success" } } } } } } }, "/data/v1/downloads/{id}": { "get": { "summary": "Download a report based on job ID.", "tags": [ "Data" ], "operationId": "downloadReport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "example": "arr,subscriptions,subscriber_loss,mrr_add_on,product_name 0.0,1.0,0.0,0.0,primary subscription (addon-subscription)" } } } }, "400": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDownloadIdResponseBad" } } } } } } } }, "security": [ { "auth": [] } ], "tags": [ { "name": "Accounts", "description": "Use the **/accounts** endpoint of the FastSpring API to create, update, or get information on FastSpring customer accounts created by you or created automatically by FastSpring when a new customer places an order.\n" }, { "name": "Coupons", "description": "Use the /coupons endpoint to create, update, delete and get coupons to offer promotional product discounts.\n" }, { "name": "Events", "description": "Use the /events endpoint to retrieve the payloads for passed webhook events. Events are either processed or unprocessed, depending on whether the webhook endpoint has acknowledged the handling of the event. \n" }, { "name": "Orders", "description": "This article provides information about the /orders endpoint of the FastSpring API.\n\nUse the **/orders** API endpoint to retrieve information about a single order or retrieve a list of multiple orders matching a set of criteria.\n\nYou can retrieve orders by order ID, product path, or date range. You can optionally combine parameters in your request, for example, retrieving all orders for a particular product that occurred in a given date range.\n\nWhen retrieving multiple orders, the API paginates the response with a limit of 50 records per page by default. To assist with paging through the results, you can optionally specify a custom limit to the number of records per page, and the desired **page** number in your request.\n" }, { "name": "Products", "description": "Use the /products endpoint to create or update products." }, { "name": "Returns", "description": "Use the /returns endpoint to retrieve return details or create full order returns. \n" }, { "name": "Sessions", "description": "A session may contain discounts, price overrides, custom tags, and more. When you create a session via the [FastSpring API](https://fastspring.com/docs/fastspring-api), the response from the API includes the session ID, which you can use to collect payment. A customer cannot change the details of the session. A successful payment via the session creates an order record.\n\n### Session Behavior\n\n- **Expiration:** Sessions created via the /sessions endpoint are valid for 24 hours by default and up to 7 days if specified. Use \"expiration\" with a value between 1 and 7 to represents the number of days to remain valid.\n\n- **Customer Accounts:** Posts to the /sessions endpoint require an existing customer account. If your customer has purchased from you previously and you have obtained the customer's FastSpring-generated account ID, you can pass that into the POST. Otherwise, you need to pre-create an account with the customer's name and email address via the API. See [/accounts](https://fastspring.com/docs/accounts).\n\n- **Products Allowed:** Each session or order can only contain a single occurrence of any given product or its [product variations](https://fastspring.com/docs/product-variations). If you include more than one variation of the same product in a single session, it will result in an error 400 with the message \"Item exists.\"\n\n- **Session Object:** The recipient object used with the [Store Builder Library session object](https://fastspring.com/docs/access-the-library-with-javascript/#AccessingtheLibraryfromJavascript-sessionUnderstandingtheSessionObject) and fastspring.builder.recognizeRecipients() method is not currently supported via the /sessions API endpoint. It is not possible to pre-fill [gift recipient](https://fastspring.com/docs/gift-purchases/) information via the /sessions endpoint.\n\n- **Customer Country:** The account country is required for certain non-credit card payment methods so be sure the customer account includes the customer's country. Transactions based on sessions could fail if the country is not included in the customer's account.\n\nAn example to use the /sessions API endpoint is to provide customers with an option to pay what you want. Design your website to accept price data from your customers and use the /sessions endpoint to create a session that overrides the default prices. Alternatively, you can do this using a [secure request](https://fastspring.com/docs/passing-sensitive-data-with-secure-requests) via the [Store Builder Library](https://fastspring.com/docs/get-started-with-store-builder-library/). Read more about the [Order Flow](https://fastspring.com/docs/Order-Flow).\n" }, { "name": "Subscriptions", "description": "Use the /subscriptions endpoint to retrieve complete details of one or more specific subscription instances.\n" }, { "name": "Quotes", "description": "This article provides information about the /coupons endpoint of the FastSpring API. \n\nUse this endpoint to create, update, delete, and get coupons.\n" }, { "name": "Data", "description": "Use the /data/v1/ to generate sync or async reports based on the flag \"async\". Also available to download and verify job status.\n\n### To take into account in the requests to generate the reports:\nIf **async** flag is not specified in the request, the report will be generated as async = false as long as days between startDate and endDate are not greater than 90.\n\nIf **pageCount** is not specified in the request, it will take 1000 as default. pageCount and pageNumber are used only when \"async\": false\n\n- **filter.startDate** - Only return results after this date\n\n- **filter.endDate** - Only return results before this date\n\n- **filter.productNames** - Optional. Only return items with these product names\n\n- **filter.productPaths** - Optional. Only return items with these product paths\n\n- **filter.countryISO** - Optional. Only return items with these country ISO\n\n- **filter.segments** - Optional. Only return items with these segments\n\n- **filter.syncDate** - Optional. Only return updated items before this date\n\n- **groupBy** - Optional. Aggregate results by these columns. If no groupBy is included this returns raw data. If the reportColumns filter is used a non-numerical column when using the groupBy filter, it will be automatically used in the groupBy even if that column is not in the groupBy filter.\n\n- **pageCount** - Optional. The max number of records to return per page. Max value is 1k when async = false. \n\n- **pageNumber** - Optional. 0 based page number.\n\n- **async** - Optional. Flag to define if the report will be generated asynchronous or not.\n\n- **reportColumns** - Optional. List of columns to include in the report. Excluding this will return all columns without using groupBy filter. If the groupBy filter is used, the data service will just return columns used in the groupBy and the requested in reportColumns filter as well.\n\n- **notificationEmails** - Optional. List of emails to notify when report is generated by using the flag async = true. \n" } ], "servers": [ { "url": "https://api.fastspring.com/" } ], "components": { "securitySchemes": { "auth": { "type": "http", "scheme": "basic" } }, "schemas": { "DeleteProductsResponse": { "title": "DeleteProductsResponse", "example": { "products": [ { "action": "products.delete", "result": "success", "product": "deletion-test-2" } ] } }, "DeleteProductsResponseBad": { "title": "DeleteProductsResponseBad", "example": { "products": [ { "action": "products.delete", "product": "deletion-test", "result": "error", "error": { "product": "Not found" } } ] } }, "PostSessionsResponse": { "title": "PostSessionsResponse", "example": { "id": "FnE_y0t9R_WF5b2W0DI72Q", "currency": "USD", "expires": 1490109872476, "order": null, "account": "uKj7izONRfanVwBL9eiG_A", "subtotal": 9.95, "items": [ { "product": "example-product-1", "quantity": 1 } ] } }, "PostSessionsResponseBad": { "title": "PostSessionsResponseBad", "example": { "message": "Can not parse request body.", "params": [] } }, "GenerateSubscriptionReportRequest": { "title": "GenerateSubscriptionReportRequest", "example": { "filter": { "startDate": "2022-06-21T00:00:00.000Z", "endDate": "2022-06-21T00:00:00.000Z", "syncDate": "2022-01-01T00:00:00.000Z", "countryISO": [ "CO", "VE" ], "productNames": [ "primary subscription (addon-subscription)" ], "productPaths": [ "primary subscription (addon-subscription)" ], "segments": [ "demographic" ] }, "reportColumns": [ "activations", "arr", "average_mrr", "buyer_email", "buyer_id", "cancellations", "chargeback_true_false", "churn_type", "company_id", "company_name", "country_iso", "country_name", "coupon", "customer_churn", "discount", "driving_offer_type", "driving_product_path", "item_id", "lifetime_value", "mrr", "mrr_decrease", "mrr_downgrade", "mrr_growth_rate", "mrr_increase", "mrr_paused", "mrr_resumed", "mrr_upgrade", "new_subscribers", "occurred_date", "product_display_name", "product_id", "product_name", "product_path", "purchase_type", "return_true_false", "revenue_churn", "segment", "store_id", "store_name", "subscriber_loss", "subscribers", "subscription_id", "subscription_period", "subscription_period_end", "subscription_period_start", "subscription_start_date", "subscription_status", "subscription_true_false", "subscriptions", "sync_date", "transaction_currency", "transaction_date", "transaction_day", "transaction_month", "transaction_time_utc", "transaction_year" ], "groupBy": [ "buyer_email", "buyer_id", "chargeback_true_false", "company_id", "company_name", "country_iso", "country_name", "coupon", "discount", "driving_offer_type", "driving_product_path", "item_id", "occurred_date", "order_id", "product_display_name", "product_id", "product_name", "product_path", "purchase_type", "return_true_false", "store_id", "store_name", "subscription_period", "subscription_period_end", "subscription_period_start", "subscription_start_date", "subscription_status", "subscription_true_false", "sync_date", "transaction_currency", "transaction_date", "transaction_month", "transaction_year" ], "pageCount": 30, "pageNumber": 0, "async": false, "notificationEmails": [ "any@fastspring.com" ] }, "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/FilterSubscriptionReportRequest" }, "reportColumns": { "type": "array", "items": { "type": "string" } }, "groupBy": { "type": "array", "items": { "type": "string" } }, "pageCount": { "type": "integer", "minimum": 1, "maximum": 1000, "format": "int32" }, "pageNumber": { "type": "integer", "minimum": 0, "format": "int32" }, "async": { "type": "boolean" }, "notificationEmails": { "type": "array", "items": { "type": "string" } } } }, "PostSubscriptionSyncResponse": { "title": "PostSubscriptionSyncResponse", "example": { "report": [ { "arr": 1080, "subscriptions": 1, "subscriber_loss": 0, "customer_churn": 0, "subscribers": 1, "mrr_growth_rate": 0, "new_subscribers": 0, "average_mrr": 90, "mrr": 90, "product_name": "primary subscription (addon-subscription)", "occurred_date": "2022-06-21T00:00:00.000Z", "cancellations": 0, "revenue_churn": 0, "lifetime_value": 0, "mrr_decrease": 0, "mrr_increase": 0, "site_id": "XhY8La7GTfs", "country_name": "Uruguay", "activations": 0 } ], "request": { "filter": { "startDate": "2022-06-21T00:00:00.000Z", "endtDate": "2022-06-21T00:00:00.000Z", "productNames": [ "primary subscription (addon-subscription)" ], "countryNames": [ "Uruguay" ] }, "reportColumns": null, "pageCount": 30, "pageNumber": 0, "async": false, "notificationEmails": [ "any@fastspring.com" ] } } }, "PostSubscriptionAsyncResponse": { "title": "PostSubscriptionAsyncResponse", "example": { "id": "JOBAZXRDGMSYZDNZELLVJIY7GBTHM", "name": "SubscriptionReport", "status": "PROCESSING", "request": { "filter": { "startDate": "2022-04-01T00:00:00.000Z", "endDate": "2022-08-28T00:00:00.000Z", "productNames": [ "primary subscription (addon-subscription)" ], "countryNames": [ "Uruguay" ] }, "reportColumns": [ "arr", "subscriptions", "subscriber_loss", "mrr_add_on", "product_name" ], "pageCount": 30, "pageNumber": 0, "async": true, "notificationEmails": [ "any@fastspring.com" ] } } }, "PostSubscriptionResponseBad": { "title": "PostSubscriptionResponseBad", "example": { "status": "BAD_REQUEST", "timestamp": "31-08-2022 06:53:43", "id": "FSPFTG5AL6ORDWRHDZLL5GUIZNAQ", "message": "Invalid sql", "details": null, "errors": [] } }, "GenerateRevenueReportRequest": { "title": "GenerateRevenueReportRequest", "example": { "filter": { "startDate": "2022-06-21T00:00:00.000Z", "endDate": "2022-06-21T00:00:00.000Z", "countryISO": [ "CO" ], "productNames": [ "toxin product (toxin-product)" ], "productPaths": [ "toxin-product" ], "segments": [ "demographic" ], "syncDate": "2022-01-01T00:00:00.000Z" }, "reportColumns": [ "buyer_id", "buyer_email", "chargeback_true_false", "company_id", "company_name", "country_iso", "country_name", "countryiso", "coupon", "digital_backup_fulfillment_fee", "digital_backup_fulfillment_fee_in_usd", "digital_fulfillment_fee", "digital_fulfillment_fee_in_usd", "discount", "driving_offer_type", "driving_product_path", "end_date", "enddate", "fixed_fee", "fixed_fee_in_usd", "grand_total_in_usd", "income", "income_in_usd", "item_id", "order_count", "order_id", "physical_backup_fulfillment_fee", "physical_backup_fulfillment_fee_in_usd", "product_count", "product_display_name", "product_id", "product_name", "product_path", "product_units", "productpath", "purchase_type", "return_fee", "return_fee_in_usd", "return_true_false", "segment", "start_date", "startdate", "store_chargeback_fee", "store_id", "store_name", "subscription_period", "subscription_period_end", "subscription_period_start", "subscription_start_date", "subscription_status", "subscription_true_false", "syncdate", "tax", "tax_fee", "tax_fee_in_usd", "tax_in_usd", "transaction_amount", "transaction_amount_in_usd", "transaction_currency", "transaction_date", "transaction_day", "transaction_fee", "transaction_fee_in_usd", "transaction_item_count", "transaction_month", "transaction_rate", "transaction_time_utc", "transaction_year" ], "groupBy": [ "buyer_email", "buyer_id", "chargeback_true_false", "company_id", "country_iso", "company_name", "country_name", "coupon", "discount", "driving_offer_type", "driving_product_path", "end_date", "item_id", "order_id", "product_display_name", "product_id", "product_name", "product_path", "purchase_type", "return_true_false", "segment", "start_date", "store_id", "store_name", "subscription_period", "subscription_status", "subscription_true_false", "transaction_currency", "transaction_date", "transaction_day", "transaction_month", "transaction_year", "countryiso", "enddate", "productpath", "startdate", "syncdate" ], "pageCount": 30, "pageNumber": 0, "async": false, "notificationEmails": [ "any@fastspring.com" ] }, "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/FilterRevenueReportRequest" }, "reportColumns": { "type": "array", "items": { "type": "string" } }, "groupBy": { "type": "array", "items": { "type": "string" } }, "pageCount": { "type": "integer", "minimum": 1, "maximum": 1000, "format": "int32" }, "pageNumber": { "type": "integer", "minimum": 0, "format": "int32" }, "async": { "type": "boolean" }, "notificationEmails": { "type": "array", "items": { "type": "string" } } } }, "PostRevenueSyncResponse": { "title": "PostRevenueSyncResponse", "example": { "report": [ { "coupon": "10OFF", "company_name": "FastSpring QA", "country_name": "Colombia", "country_iso": "CO", "return_true_false": false } ], "request": { "filter": { "startDate": "2022-01-01T00:00:00.000Z", "endtDate": "2022-01-11T00:00:00.000Z", "syncDate": "2022-01-01T00:00:00.000Z", "productNames": [ "toxin product (toxin-product)" ], "productPaths": [ "toxin-product" ], "countryISO": [ "CO" ] }, "reportColumns": [ "Company_Name", "Country_ISO", "Country_Name", "Coupon" ], "groupBy": [ "Company_Name", "Country_ISO", "Country_Name" ], "pageCount": 30, "pageNumber": 0, "async": false, "notificationEmails": [ "any@fastspring.com" ] } } }, "PostRevenueAsyncResponse": { "title": "PostRevenueAsyncResponse", "example": { "id": "JOBAKP3KVAHPFHMVMSPHFRS7OWJCI", "name": "RevenueReport", "status": "PROCESSING", "request": { "filter": { "startDate": "2020-01-01T00:00:00.000Z", "endDate": "2020-01-11T00:00:00.000Z", "syncDate": "2022-01-01T00:00:00.000Z", "productNames": [ "toxin product (toxin-product)" ], "productPaths": [ "toxin-product" ], "countryISO": [ "CO" ] }, "groupBy": [ "Company_Name", "Country_ISO", "Country_Name" ], "reportColumns": [ "Company_Name", "Country_ISO", "Country_Name", "Coupon" ], "pageCount": 30, "pageNumber": 0, "async": true, "notificationEmails": [ "any@fastspring.com" ] } } }, "PostRevenueResponseBad": { "title": "PostRevenueResponseBad", "example": { "status": "BAD_REQUEST", "timestamp": "31-08-2022 06:53:43", "id": "FSPFTG5AL6ORDWRHDZLL5GUIZNAQ", "message": "< fixed_fee_in_us > field is not valid", "details": null, "errors": [ { "erroCode": "invalid.field", "field": "fixed_fee_in_us", "message": "< fixed_fee_in_us > field is not valid", "rejectedValue": "fixed_fee_in_us" } ] } }, "GetJobIdResponse": { "title": "GetJobIdResponse", "example": { "id": "JOBZNCFWNVJOZGBFBGBFFFTMEUBPM", "status": "COMPLETE", "name": "RevenueReport", "created": "2022-09-08T12:11:01.000Z", "completeDate": "2022-09-08T12:12:35.000Z", "downloadUrl": "https://api.fastspring.com/data/v1/downloads/JOBZNCFWNVJOZGBFBGBFFFTMEUBPM", "notificationEmails": [ "any@fastspring.com" ] } }, "GetJobIdResponseBad": { "title": "GetJobIdResponseBad", "example": { "status": "BAD_REQUEST", "timestamp": "31-08-2022 06:53:43", "id": "FS2J43PGKSMNEG7LNV7AYLKPJND4", "message": "Invalid JobId", "details": null, "errors": [ { "erroCode": "invalid", "field": "jobId", "message": "Invalid JobId", "rejectedValue": "JOBZNCFWNVJOZGBFBGBFFFTMEUBP" } ] } }, "GetEventsResponseBad": { "title": "GetEventsResponseBad", "example": { "action": "events.get", "result": "error", "error": { "begin": "Can not parse begin", "end": "Can not parse end.", "days": "Can not parse days." } } }, "GetJobsResponse": { "title": "GetJobsResponse", "example": [ { "id": "JOBZNCFWNVJOZGBFBGBFFFTMEUBPM", "status": "COMPLETE", "name": "RevenueReport", "created": "2022-09-08T12:11:01.000Z", "completeDate": "2022-09-08T12:12:35.000Z", "downloadUrl": "https://api.fastspring.com/data/v1/downloads/JOBZNCFWNVJOZGBFBGBFFFTMEUBPM", "notificationEmails": [ "any@fastspring.com" ] }, { "id": "JOBZHZNSFRSZVDHDHMWNRJU4D2QNM", "status": "FAILED", "name": "SubscriptionReport", "created": "2022-09-08T12:11:01.000Z", "notificationEmails": [ "any@fastspring.com" ] } ] }, "GetDownloadIdResponseBad": { "title": "GetDownloadIdResponseBad", "example": { "status": "BAD_REQUEST", "timestamp": "31-08-2022 06:53:43", "id": "FS2J43PGKSMNEG7LNV7AYLKPJND4", "message": "Invalid JobId", "details": null, "errors": [ { "erroCode": "invalid", "field": "jobId", "message": "Invalid JobId", "rejectedValue": "JOBZNCFWNVJOZGBFBGBFFFTMEUBP" } ] } }, "GetEventsResponse": { "title": "GetEventsResponse", "example": { "action": "events.get", "result": "success", "page": null, "limit": null, "nextPage": null, "total": 0, "events": [ { "id": "88qMx0P2RZCalzQ5ERXfXA", "processed": false, "created": 1542239788941, "type": "payoutEntry.created", "live": false, "data": { "orderId": "EGr98BxdQ-idUfSZf_g-gw", "reference": "YES200314-8442-49161", "live": false, "order": { "order": "EGr98BxdQ-idUfSZf_g-gw", "id": "EGr98BxdQ-idUfSZf_g-gw", "reference": "YES200314-8442-49161", "buyerReference": null, "completed": true, "changed": 1542239788922, "changedValue": 1542239788922, "changedInSeconds": 1542239788, "changedDisplay": "03/14/20", "language": "en", "live": false, "currency": "USD", "payoutCurrency": "USD", "invoiceUrl": "https://youexamplestore.onfastspring.com/account/order/FUR181114-8442-49161/invoice", "account": "N8FjcSWcQNeYCc-suM1O8g", "total": 59.99, "totalDisplay": "$59.99", "totalInPayoutCurrency": 59.99, "totalInPayoutCurrencyDisplay": "$59.99", "tax": 0, "taxDisplay": "$0.00", "taxInPayoutCurrency": 0, "taxInPayoutCurrencyDisplay": "$0.00", "subtotal": 59.99, "subtotalDisplay": "$59.99", "subtotalInPayoutCurrency": 59.99, "subtotalInPayoutCurrencyDisplay": "$59.99", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "discountWithTax": 0, "discountWithTaxDisplay": "$0.00", "discountWithTaxInPayoutCurrency": 0, "discountWithTaxInPayoutCurrencyDisplay": "$0.00", "billDescriptor": "FS* fsprg.com", "payment": { "type": "test", "cardEnding": "4242" }, "customer": { "first": "Marcellus", "last": "Walrus", "email": "ne1@all.com", "company": "Acme, Inc.", "phone": null }, "address": { "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" }, "recipients": [ { "recipient": { "first": "Marcellus", "last": "Walrus", "email": "ne1@all.com", "company": "Acme, Inc.", "phone": null, "account": "N8FjcSWcQNeYCc-suM1O8g", "address": { "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" } } } ], "notes": [], "items": [ { "product": "example-product-1", "quantity": 1, "display": "Example Product 1", "sku": "skuex1", "subtotal": 59.99, "subtotalDisplay": "$59.99", "subtotalInPayoutCurrency": 59.99, "subtotalInPayoutCurrencyDisplay": "$59.99", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "fulfillments": { "example-product-1_file_2": [ { "display": "EXAMPLE.EXE", "size": 129, "file": "https://yourexamplestore.onfastspring.com/account/file/YES200314-8442-79162F", "type": "file" } ], "example-product-1_license_0": [ { "license": "Example-aw0r5H3YKBf8w9FNSqI2", "display": "License Key", "type": "license" } ], "instructions": "Thank you for purchasing Example Product 1. To register, please launch the trial version and select Help | Register Example Product 1. Then, copy and paste the license key above into the License Key field and click Submit." } } ] }, "account": { "id": "N8FjcSWcQNeYCc-suM1O8g", "account": "N8FjcSWcQNeYCc-suM1O8g", "contact": { "first": "Marcellus", "last": "Walrus", "email": "ne1@all.com", "company": "Acme, Inc.", "phone": null }, "language": "en", "country": "US", "lookup": { "global": "TVWhu0iwQhKJyuhpT_2yMw" }, "url": "https://yourexamplestore.onfastspring.com/account" }, "subscriptions": [], "subtractions": { "tax": { "currency": "USD", "amount": 0, "percentage": 0 }, "fastspring": { "currency": "USD", "amount": 5.3391, "percentage": 8.9 } }, "payouts": [ { "payee": "exmaplepayee", "currency": "USD", "payout": "54.65", "subtotal": 54.65, "total": "59.99" } ] }, "event": "88qMx0P2RZCalzQ5ERXfXA" }, { "id": "f_4YLUhbTPyaFhFPMKncWQ", "processed": false, "created": 1542239789431, "type": "order.completed", "live": false, "data": { "order": "EGr98BxdQ-idUfSZf_g-gw", "id": "EGr98BxdQ-idUfSZf_g-gw", "reference": "YES200314-8442-49161", "buyerReference": null, "completed": true, "changed": 1542239788922, "changedValue": 1542239788922, "changedInSeconds": 1542239788, "changedDisplay": "03/14/20", "language": "en", "live": false, "currency": "USD", "payoutCurrency": "USD", "invoiceUrl": "https://yourexamplestore.onfastspring.com/account/order/YES200314-8442-49161/invoice", "account": { "id": "N8FjcSWcQNeYCc-suM1O8g", "account": "N8FjcSWcQNeYCc-suM1O8g", "contact": { "first": "Marcellus", "last": "Walrus", "email": "ne1@all.com", "company": "Acme, Inc.", "phone": null }, "language": "en", "country": "US", "lookup": { "global": "TVWhu0iwQhKJyuhpT_2yMw" }, "url": "https://yourexamplestore.onfastspring.com/account" }, "total": 59.99, "totalDisplay": "$59.99", "totalInPayoutCurrency": 59.99, "totalInPayoutCurrencyDisplay": "$59.99", "tax": 0, "taxDisplay": "$0.00", "taxInPayoutCurrency": 0, "taxInPayoutCurrencyDisplay": "$0.00", "subtotal": 59.99, "subtotalDisplay": "$59.99", "subtotalInPayoutCurrency": 59.99, "subtotalInPayoutCurrencyDisplay": "$59.99", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "discountWithTax": 0, "discountWithTaxDisplay": "$0.00", "discountWithTaxInPayoutCurrency": 0, "discountWithTaxInPayoutCurrencyDisplay": "$0.00", "billDescriptor": "FS* fsprg.com", "payment": { "type": "test", "cardEnding": "4242" }, "customer": { "first": "Marcellus", "last": "Walrus", "email": "ne1@all.com", "company": "Acme, Inc.", "phone": null }, "address": { "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" }, "recipients": [ { "recipient": { "first": "Marcellus", "last": "Walrus", "email": "ne1@all.com", "company": "Acme, Inc.", "phone": null, "account": { "id": "N8FjcSWcQNeYCc-suM1O8g", "account": "N8FjcSWcQNeYCc-suM1O8g", "contact": { "first": "Marcellus", "last": "Walrus", "email": "ne1@all.com", "company": "Acme, Inc.", "phone": null }, "language": "en", "country": "US", "lookup": { "global": "TVWhu0iwQhKJyuhpT_2yMw" }, "url": "https://yourexamplestore.onfastspring.com/account" }, "address": { "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" } } } ], "notes": [], "items": [ { "product": "example-product-1", "quantity": 1, "display": "Example Product 1", "sku": "skuex1", "subtotal": 59.99, "subtotalDisplay": "$59.99", "subtotalInPayoutCurrency": 59.99, "subtotalInPayoutCurrencyDisplay": "$59.99", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "fulfillments": { "example-product-1_file_2": [ { "display": "EXAMPLE.EXE", "size": 129, "file": "https://yourexamplestore.onfastspring.com/account/file/YES200314-8442-79162F", "type": "file" } ], "example-product-1_license_0": [ { "license": "Example-aw0r5H3YKBf8w9FNSqI2", "display": "License Key", "type": "license" } ], "instructions": "Thank you for purchasing Example Product 1. To register, please launch the trial version and select Help | Register Examle Product 1. Then, copy and paste the license key above into the License Key field and click Submit." } } ] }, "event": "f_4YLUhbTPyaFhFPMKncWQ" }, { "id": "ik6eEaJHSlC-_ML8xzW5RQ", "processed": false, "created": 1542240018122, "type": "mailingListEntry.updated", "live": false, "data": { "id": "0cb4fdfbcf39be1eb6dd6c2032c8397fb7b60f604ba6094c6b261323a7641226", "list": "subscribed", "updated": 1542239788792, "reason": "subscribed", "order": { "reference": "YES200314-8442-49161", "id": "EGr98BxdQ-idUfSZf_g-gw", "order": "EGr98BxdQ-idUfSZf_g-gw", "items": [ { "product": "example-product-1", "quantity": 1, "display": "Example Product 1", "summary": "This is the **Summary** for Example Product 1", "imageUrl": "https://d8y8nchqlnmka.cloudfront.net/VTetZH1kQD8/x4CxtvLjTBo/example-box.png" } ] }, "email": "ne1@all.com", "firstName": "Marcellus", "lastName": "Walrus", "country": "US", "currency": "USD", "language": "en", "storefront": "yourexamplestore" }, "event": "ik6eEaJHSlC-_ML8xzW5RQ" } ], "more": true } }, "GetCouponCodesRequest": { "title": "GetCouponCodesRequest", "example": { "codes": [ "code1", "code2" ] } }, "GetCouponCodesResponse": { "title": "GetCouponCodesResponse", "example": { "coupon": "AXL", "codes": [ "AXL1" ] } }, "GetCouponsDetailsResponse": { "title": "GetCouponsDetailsResponse", "example": { "coupon": "blackfriday", "discount": { "type": "percent", "percent": 20 }, "combine": false, "reason": { "en": "Holiday Savings!" }, "limit": "1", "available": { "start": "2018-11-01 00:00", "end": "2018-12-25 22:59" }, "codes": [ "0793PE2TSK", "0BXB6NMMCT" ], "products": [] } }, "PostReturnsRequest": { "title": "PostReturnsRequest", "example": { "returns": [ { "order": "17VblT1XR1aAnIIScCgpfw", "reason": "DUPLICATE_ORDER", "note": "As requested by customer", "notification": "ORIGINAL" } ] } }, "PostReturnsResponse": { "title": "PostReturnsResponse", "example": { "returns": [ { "return": "JV8jCQrJT1GD7yndYgrorw", "reference": "FUR191003-4739-52106X", "completed": true, "changed": 1570130905372, "changedValue": 1570130905372, "changedInSeconds": 1570130905, "changedDisplay": "10/3/19", "live": true, "account": "2-hl9JWwQrualioCsY5lbg", "currency": "USD", "payoutCurrency": "USD", "totalReturn": 5.31, "totalReturnDisplay": "$5.31", "totalReturnInPayoutCurrency": 5.31, "totalReturnInPayoutCurrencyDisplay": "$5.31", "tax": 0.36, "taxDisplay": "$0.36", "taxInPayoutCurrency": 0.36, "taxInPayoutCurrencyDisplay": "$0.36", "subtotal": 4.95, "subtotalDisplay": "$4.95", "subtotalInPayoutCurrency": 4.95, "subtotalInPayoutCurrencyDisplay": "$4.95", "totalRefundInPayoutCurrency": 5.31, "payment": { "type": "creditcard", "creditcard": "visa", "cardEnding": "0369" }, "reason": "DUPLICATE_ORDER", "note": "As requested by customer", "original": { "id": "kfPW5xbyTG-TuivKhtZYrA", "order": "kfPW5xbyTG-TuivKhtZYrA", "reference": "FUR191003-8210-23117", "account": "2-hl9JWwQrualioCsY5lbg", "currency": "USD", "payoutCurrency": "USD", "total": 5.31, "totalDisplay": "$5.31", "totalInPayoutCurrency": 5.31, "totalInPayoutCurrencyDisplay": "$5.31", "tax": 0.36, "taxDisplay": "$0.36", "taxInPayoutCurrency": 0.36, "taxInPayoutCurrencyDisplay": "$0.36", "subtotal": 4.95, "subtotalDisplay": "$4.95", "subtotalInPayoutCurrency": 4.95, "subtotalInPayoutCurrencyDisplay": "$4.95", "notes": [] }, "customer": { "first": "Leeroy", "last": "Jenkins", "email": "ne1@all.com", "company": null, "phone": null }, "items": [ { "product": "eggs", "quantity": 1, "display": "Eggs", "sku": "falcon1", "subtotal": 4.95, "subtotalDisplay": "$4.95", "subtotalInPayoutCurrency": 4.95, "subtotalInPayoutCurrencyDisplay": "$4.95", "attributes": { "conditions": "{exclude:{countries:['AT','GB']}}" } } ], "action": "return.create", "result": "success" } ] } }, "GetReturnsResponse": { "title": "GetReturnsResponse", "example": { "returns": [ { "return": "QpMoe70PT5mMb5OMT4N5lA", "reference": "SUD160811-6921-74128X", "completed": true, "changed": 1470953997043, "changedValue": 1470953997043, "changedInSeconds": 1470953997, "changedDisplay": "8/11/16", "live": false, "account": "_sOMzG2pSIyAeWXkcoNgUA", "currency": "USD", "payoutCurrency": "USD", "totalReturn": 10, "totalReturnDisplay": "$10.00", "totalReturnInPayoutCurrency": 10, "totalReturnInPayoutCurrencyDisplay": "$10.00", "tax": 0, "taxDisplay": "$0.00", "taxInPayoutCurrency": 0, "taxInPayoutCurrencyDisplay": "$0.00", "subtotal": 10, "subtotalDisplay": "$10.00", "subtotalInPayoutCurrency": 10, "subtotalInPayoutCurrencyDisplay": "$10.00", "totalRefundInPayoutCurrency": 10, "payment": { "type": "test", "cardEnding": "4242" }, "reason": "Product Not Received", "note": "Note during the refund of the order(Canceling The Subscription)", "type": "RETURN", "original": { "id": "embMdXyCQZinGxkk2v85GA", "order": "embMdXyCQZinGxkk2v85GA", "reference": "SUD160811-1752-43151", "account": "_sOMzG2pSIyAeWXkcoNgUA", "currency": "USD", "payoutCurrency": "USD", "total": 10, "totalDisplay": "$10.00", "totalInPayoutCurrency": 10, "totalInPayoutCurrencyDisplay": "$10.00", "tax": 0, "taxDisplay": "$0.00", "taxInPayoutCurrency": 0, "taxInPayoutCurrencyDisplay": "$0.00", "subtotal": 10, "subtotalDisplay": "$10.00", "subtotalInPayoutCurrency": 10, "subtotalInPayoutCurrencyDisplay": "$10.00", "notes": [ { "note": "Before canceling the subscription", "creator": "admin@yourexamplestore.com" } ], "subscriptions": [ "RPN1Bp62Q3mEXloZvxUxmg" ] }, "customer": { "first": "Test", "last": "Order", "email": "test@tes.com", "company": "Test", "phone": "1234567890" }, "items": [ { "product": "newtestsuborder", "quantity": 1, "display": "newtestsuborder", "sku": null, "subtotal": 10, "subtotalDisplay": "$10.00", "subtotalInPayoutCurrency": 10, "subtotalInPayoutCurrencyDisplay": "$10.00", "subscription": "RPN1Bp62Q3mEXloZvxUxmg" } ], "action": "return.get", "result": "success" } ] } }, "PauseSubscriptionRequest": { "title": "PauseSubscriptionRequest", "properties": { "pausePeriodCount": { "type": "integer", "format": "int32" } }, "example": [ { "pausePeriodCount": 2 } ] }, "PauseSubscriptionResponse": { "title": "PauseSubscriptionResponse", "example": { "id": "fPNQtjeSTOW0-tfaiyW6cA", "quote": null, "subscription": "fPNQtjeSTOW0-tfaiyW6cA", "active": true, "state": "active", "isSubscriptionEligibleForPauseByBuyer": false, "isPauseScheduled": true, "changed": 1659631759255, "changedValue": 1659631759255, "changedInSeconds": 1659631759, "changedDisplay": "8/4/22", "changedDisplayISO8601": "2022-08-04", "live": false, "currency": "USD", "account": "auqeDztxSrG_brzKUlZGng", "product": "monthly-prodsub-digauto", "sku": null, "display": "Monthly prodSub DigAuto", "quantity": 1, "adhoc": false, "autoRenew": true, "price": 100, "priceDisplay": "$100.00", "priceInPayoutCurrency": 100, "priceInPayoutCurrencyDisplay": "$100.00", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "subtotal": 100, "subtotalDisplay": "$100.00", "subtotalInPayoutCurrency": 100, "subtotalInPayoutCurrencyDisplay": "$100.00", "next": 1672790400000, "nextValue": 1672790400000, "nextInSeconds": 1672790400, "nextDisplay": "1/4/23", "nextDisplayISO8601": "2023-01-04", "end": null, "endValue": null, "endInSeconds": null, "endDisplay": null, "endDisplayISO8601": null, "canceledDate": null, "canceledDateValue": null, "canceledDateInSeconds": null, "canceledDateDisplay": null, "canceledDateDisplayISO8601": null, "deactivationDate": null, "deactivationDateValue": null, "deactivationDateInSeconds": null, "deactivationDateDisplay": null, "deactivationDateDisplayISO8601": null, "sequence": 1, "periods": null, "remainingPeriods": null, "begin": 1659571200000, "beginValue": 1659571200000, "beginInSeconds": 1659571200, "beginDisplay": "8/4/22", "beginDisplayISO8601": "2022-08-04", "intervalUnit": "month", "intervalLength": 1, "nextChargeCurrency": "USD", "nextChargeDate": 1672790400000, "nextChargeDateValue": 1672790400000, "nextChargeDateInSeconds": 1672790400, "nextChargeDateDisplay": "1/4/23", "nextChargeDateDisplayISO8601": "2023-01-04", "nextChargePreTax": 100, "nextChargePreTaxDisplay": "$100.00", "nextChargePreTaxInPayoutCurrency": 100, "nextChargePreTaxInPayoutCurrencyDisplay": "$100.00", "nextChargeTotal": 100, "nextChargeTotalDisplay": "$100.00", "nextChargeTotalInPayoutCurrency": 100, "nextChargeTotalInPayoutCurrencyDisplay": "$100.00", "paymentOverdue": { "intervalUnit": "week", "intervalLength": 1, "total": 4, "sent": 0 }, "cancellationSetting": { "cancellation": "AFTER_LAST_NOTIFICATION", "intervalUnit": "week", "intervalLength": 1 }, "pauseDate": 1667520000000, "pauseDateValue": 1667520000000, "pauseDateInSeconds": 1667520000, "pauseDateDisplay": "11/4/22", "pauseDateDisplayISO8601": "2022-11-04", "resumeDate": 1672790400000, "resumeDateValue": 1672790400000, "resumeDateInSeconds": 1672790400, "resumeDateDisplay": "1/4/23", "resumeDateDisplayISO8601": "2023-01-04", "fulfillments": {}, "instructions": [ { "product": "monthly-prodsub-digauto", "type": "regular", "periodStartDate": null, "periodStartDateValue": null, "periodStartDateInSeconds": null, "periodStartDateDisplay": null, "periodStartDateDisplayISO8601": null, "periodEndDate": null, "periodEndDateValue": null, "periodEndDateInSeconds": null, "periodEndDateDisplay": null, "periodEndDateDisplayISO8601": null, "intervalUnit": "month", "intervalLength": 1, "discountPercent": 0, "discountPercentValue": 0, "discountPercentDisplay": "0%", "discountTotal": 0, "discountTotalDisplay": "$0.00", "discountTotalInPayoutCurrency": 0, "discountTotalInPayoutCurrencyDisplay": "$0.00", "unitDiscount": 0, "unitDiscountDisplay": "$0.00", "unitDiscountInPayoutCurrency": 0, "unitDiscountInPayoutCurrencyDisplay": "$0.00", "price": 100, "priceDisplay": "$100.00", "priceInPayoutCurrency": 100, "priceInPayoutCurrencyDisplay": "$100.00", "priceTotal": 100, "priceTotalDisplay": "$100.00", "priceTotalInPayoutCurrency": 100, "priceTotalInPayoutCurrencyDisplay": "$100.00", "unitPrice": 100, "unitPriceDisplay": "$100.00", "unitPriceInPayoutCurrency": 100, "unitPriceInPayoutCurrencyDisplay": "$100.00", "total": 100, "totalDisplay": "$100.00", "totalInPayoutCurrency": 100, "totalInPayoutCurrencyDisplay": "$100.00" } ], "initialOrderId": "fEMc5woCSlWSwpL3u9-B9A", "initialOrderReference": "KEV220804-8637-55123", "action": "subscriptions.pause.get", "result": "success" } }, "PauseSubscriptionErrorResponse": { "title": "PauseSubscriptionErrorResponse", "example": { "action": "subscriptions.pause", "result": "error", "error": { "subscription.pause": "Invalid number of Periods." } } }, "ResumeSubscriptionErrorResponse": { "title": "ResumeSubscriptionErrorResponse", "example": { "action": "subscriptions.resume", "result": "error", "error": { "subscription.resume": "Unable to find subscription." } } }, "ChargeSubscriptionRequest": { "title": "ChargeSubscriptionRequest", "example": { "subscriptions": [ { "subscription": "subscription-id" } ] } }, "ChargeSubscriptionResponse": { "title": "ChargeSubscriptionResponse", "example": { "subscription": [ { "subscription": "subscription-id-1", "action": "subscription.charge", "result": "success" } ] } }, "ChargeSubscriptionResponseBad": { "title": "ChargeSubscriptionResponseBad", "example": { "subscription": [ { "subscription": "subscription-id-2", "action": "subscription.charge", "result": "error", "error": { "subscription": "Only 1 successful rebill per day and 4 successful rebills per 30 days allowed." } } ] } }, "SubscriptionChargeErrorResponse": { "title": "SubscriptionChargeErrorResponse", "example": { "subscription": "subscription-id", "action": "subscription.charge", "result": "error", "error": { "subscription": "EXPIRED_CARD" } } }, "SubscriptionCancelErrorResponse": { "title": "SubscriptionCancelErrorResponse", "example": { "subscription": "subscription-id", "action": "subscription.cancel", "result": "error", "error": { "subscription": "the subscription is already canceled" } } }, "SubscriptionUpdateErrorResponse": { "title": "SubscriptionUpdateErrorResponse", "example": { "subscription": "subscription-id", "action": "subscription.update", "result": "error", "error": { "subscription": "Subscription is not changeable" } } }, "SubscriptionGetErrorResponse": { "title": "SubscriptionGetErrorResponse", "example": { "subscription": "subscription-id", "action": "subscription.get", "result": "error", "error": { "subscription": "Subscription not found" } } }, "CancelSubscriptionResponse": { "title": "CancelSubscriptionResponse", "example": { "subscriptions": [ { "subscription": "id1", "action": "subscription.cancel", "result": "success" } ] } }, "CancelSubscriptionResponseBad": { "title": "CancelSubscriptionResponseBad", "example": { "subscriptions": [ { "subscription": "id2", "action": "subscription.cancel", "result": "error", "error": { "subscription": "The subscription is already canceled", "billingPeriod": "billingPeriod=0 to cancel immediately or billingPeriod=1 to cancel at the next period." } } ] } }, "ChangeProductResponseBad": { "title": "ChangeProductResponseBad", "example": { "subscriptions": [ { "subscription": "subscription-id-2", "action": "subscription.update", "result": "error", "error": { "subscription": "Not found", "next": "Date format yyyy-mm-dd or milliseconds", "end": "Set 0 for no end date or Date format yyyy-mm-dd or milliseconds", "product": "Not a subscription product", "quantity": "Must be greater than zero", "coupons": "coupon_code is not a valid coupon: DOES_NOT_EXIST/USE_LIMIT_REACHED/NOT_VALID_TODAY", "prorate": "Can't prorate on-demand subscription", "manualRenew": "Subscription is already set to manual renew" } } ] } }, "ChangeProductResponse": { "title": "ChangeProductResponse", "example": { "subscriptions": [ { "subscription": "subscription-id-1", "action": "subscription.update", "result": "success" } ] } }, "GetASubscriptionResponseBad": { "title": "GetASubscriptionResponseBad", "example": { "subscriptions": [ { "action": "subscription.get", "subscription": "LiPzVuKnT2Go1WWteQkZtx", "result": "success", "error": { "subscription": "Subscription not found" } } ] } }, "GetASubscriptionResponse": { "title": "GetASubscriptionResponse", "example": { "id": "AmYzjmPbSbWYkESv7MnwwA", "subscription": "AmYzjmPbSbWYkESv7MnwwA", "active": true, "state": "trial", "isSubscriptionEligibleForPauseByBuyer": false, "isPauseScheduled": true, "changed": 1573257599032, "changedValue": 1573257599032, "changedInSeconds": 1573257599, "changedDisplay": "11/8/19", "live": false, "declineReason": "Invalid Card number", "paymentMethod": "CREDIT_CARD", "expiry": "12/25", "cardEnding": 1234, "cardType": "VISA", "currency": "USD", "account": "N8FjcSWcQNeYCc-suM1O8g", "product": "example-monthly-subscription", "sku": "skusub1", "display": "Example Monthly Subscription", "quantity": 1, "adhoc": false, "autoRenew": true, "price": 14.95, "priceDisplay": "$14.95", "priceInPayoutCurrency": 14.95, "priceInPayoutCurrencyDisplay": "$14.95", "discount": 3.74, "discountDisplay": "$3.74", "discountInPayoutCurrency": 3.74, "discountInPayoutCurrencyDisplay": "$3.74", "subtotal": 16.21, "subtotalDisplay": "$16.21", "subtotalInPayoutCurrency": 16.21, "subtotalInPayoutCurrencyDisplay": "$16.21", "attributes": { "Furious": "Falcon", "CustomAttribute2": "CustomValue2", "CustomAttribute1": "CustomValue1" }, "discountDuration": 1, "next": 1574380800000, "nextInSeconds": 1574380800, "nextDisplay": "11/22/19", "end": null, "endValue": null, "endInSeconds": null, "endDisplay": null, "canceledDate": null, "canceledDateValue": null, "canceledDateInSeconds": null, "canceledDateDisplay": null, "deactivationDate": null, "deactivationDateValue": null, "deactivationDateInSeconds": null, "deactivationDateDisplay": null, "sequence": 1, "periods": null, "remainingPeriods": null, "begin": 1573171200000, "beginValue": 1573171200000, "beginInSeconds": 1573171200, "beginDisplay": "11/8/19", "intervalUnit": "month", "intervalLength": 1, "nextChargeCurrency": "USD", "nextChargeDate": 1574380800000, "nextChargeDateValue": 1574380800000, "nextChargeDateInSeconds": 1574380800, "nextChargeDateDisplay": "11/22/19", "nextChargePreTax": 16.21, "nextChargePreTaxDisplay": "$16.21", "nextChargePreTaxInPayoutCurrency": 16.21, "nextChargePreTaxInPayoutCurrencyDisplay": "$16.21", "nextChargeTotal": 16.21, "nextChargeTotalDisplay": "$16.21", "nextChargeTotalInPayoutCurrency": 16.21, "nextChargeTotalInPayoutCurrencyDisplay": "$16.21", "nextNotificationType": "PAYMENT_REMINDER", "nextNotificationDate": 1574294400000, "nextNotificationDateValue": 1574294400000, "nextNotificationDateInSeconds": 1574294400, "nextNotificationDateDisplay": "11/21/19", "trialReminder": { "intervalUnit": "day", "intervalLength": 3 }, "paymentReminder": { "intervalUnit": "day", "intervalLength": 1 }, "paymentOverdue": { "intervalUnit": "week", "intervalLength": 2, "total": 1, "sent": 0 }, "cancellationSetting": { "cancellation": "AFTER_LAST_NOTIFICATION", "intervalUnit": "week", "intervalLength": 1 }, "addons": [ { "product": "example-product-3", "sku": "skuex3", "display": "Example Product 3", "quantity": 1, "price": 5, "priceDisplay": "$5.00", "priceInPayoutCurrency": 5, "priceInPayoutCurrencyDisplay": "$5.00", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "subtotal": 5, "subtotalDisplay": "$5.00", "subtotalInPayoutCurrency": 5, "subtotalInPayoutCurrencyDisplay": "$5.00", "discounts": [] } ], "discounts": [ { "discountPath": "example-monthly-subscription", "discountDuration": 1, "percentValue": 25 } ], "setupFee": { "price": { "USD": 9.95 }, "title": { "en": "One-time Setup Fee" } }, "instructions": [ { "type": "trial", "periodStartDate": 1573171200000, "periodStartDateValue": 1573171200000, "periodStartDateInSeconds": 1573171200, "periodStartDateDisplay": "11/8/19", "periodEndDate": 1574294400000, "periodEndDateValue": 1574294400000, "periodEndDateInSeconds": 1574294400, "periodEndDateDisplay": "11/21/19", "discountDurationUnit": "day", "discountDurationLength": 14, "discountPercent": 100, "discountPercentValue": 100, "discountPercentDisplay": "100%", "unitDiscount": 14.95, "unitDiscountDisplay": "$14.95", "unitDiscountInPayoutCurrency": 14.95, "unitDiscountInPayoutCurrencyDisplay": "$14.95", "discountTotal": 14.95, "discountTotalDisplay": "$14.95", "discountTotalInPayoutCurrency": 14.95, "discountTotalInPayoutCurrencyDisplay": "$14.95", "total": 0, "totalDisplay": "$0.00", "totalInPayoutCurrency": 0, "totalInPayoutCurrencyDisplay": "$0.00", "price": 14.95, "priceDisplay": "$14.95", "priceInPayoutCurrency": 14.95, "priceInPayoutCurrencyDisplay": "$14.95", "priceTotal": 14.95, "priceTotalDisplay": "$14.95", "priceTotalInPayoutCurrency": 14.95, "priceTotalInPayoutCurrencyDisplay": "$14.95", "unitPrice": 0, "unitPriceDisplay": "$0.00", "unitPriceInPayoutCurrency": 0, "unitPriceInPayoutCurrencyDisplay": "$0.00" }, { "product": "example-monthly-subscription", "type": "discounted", "periodStartDate": 1574380800000, "periodStartDateValue": 1574380800000, "periodStartDateInSeconds": 1574380800, "periodStartDateDisplay": "11/22/19", "periodEndDate": 1576886400000, "periodEndDateValue": 1576886400000, "periodEndDateInSeconds": 1576886400, "periodEndDateDisplay": "12/21/19", "discountIntervalUnit": "month", "discountIntervalLength": 1, "discountDuration": 1, "discountDurationUnit": "month", "discountDurationLength": 1, "unitDiscount": 3.74, "unitDiscountDisplay": "$3.74", "unitDiscountInPayoutCurrency": 3.74, "unitDiscountInPayoutCurrencyDisplay": "$3.74", "discountPercent": 25, "discountPercentValue": 25, "discountPercentDisplay": "25%", "discountTotal": 3.74, "discountTotalDisplay": "$3.74", "discountTotalInPayoutCurrency": 3.74, "discountTotalInPayoutCurrencyDisplay": "$3.74", "price": 14.95, "priceDisplay": "$14.95", "priceInPayoutCurrency": 14.95, "priceInPayoutCurrencyDisplay": "$14.95", "priceTotal": 14.95, "priceTotalDisplay": "$14.95", "priceTotalInPayoutCurrency": 14.95, "priceTotalInPayoutCurrencyDisplay": "$14.95", "unitPrice": 11.21, "unitPriceDisplay": "$11.21", "unitPriceInPayoutCurrency": 11.21, "unitPriceInPayoutCurrencyDisplay": "$11.21", "total": 11.21, "totalDisplay": "$11.21", "totalInPayoutCurrency": 11.21, "totalInPayoutCurrencyDisplay": "$11.21" }, { "product": "example-monthly-subscription", "type": "regular", "periodStartDate": 1576972800000, "periodStartDateValue": 1576972800000, "periodStartDateInSeconds": 1576972800, "periodStartDateDisplay": "12/22/19", "periodEndDate": null, "periodEndDateValue": null, "periodEndDateInSeconds": null, "periodEndDateDisplay": null, "intervalUnit": "month", "intervalLength": 1, "discountPercent": 0, "discountPercentValue": 0, "discountPercentDisplay": "0%", "discountTotal": 0, "discountTotalDisplay": "$0.00", "discountTotalInPayoutCurrency": 0, "discountTotalInPayoutCurrencyDisplay": "$0.00", "unitDiscount": 0, "unitDiscountDisplay": "$0.00", "unitDiscountInPayoutCurrency": 0, "unitDiscountInPayoutCurrencyDisplay": "$0.00", "price": 14.95, "priceDisplay": "$14.95", "priceInPayoutCurrency": 14.95, "priceInPayoutCurrencyDisplay": "$14.95", "priceTotal": 14.95, "priceTotalDisplay": "$14.95", "priceTotalInPayoutCurrency": 14.95, "priceTotalInPayoutCurrencyDisplay": "$14.95", "unitPrice": 14.95, "unitPriceDisplay": "$14.95", "unitPriceInPayoutCurrency": 14.95, "unitPriceInPayoutCurrencyDisplay": "$14.95", "total": 14.95, "totalDisplay": "$14.95", "totalInPayoutCurrency": 14.95, "totalInPayoutCurrencyDisplay": "$14.95" } ] } }, "GetAllSubscriptionsInstancesResponse": { "title": "GetAllSubscriptionsInstances", "example": { "action": "subscription.getall", "result": "success", "nextPage": 3, "subscriptions": [ "khyNPLY3TYiQhBfHyjZINg", "w46bQ2-gTayzJfFXbV1VWg", "86cFjtgCRlSmOPbLcX_mCA", "v0yPCSTLSyarVe9NlNalSA", "FWhWZ3b6StyfiJ_GnyHswQ", "A5xx9TF_R26PcCMdagAC8Q", "pgNumDwTSbaLeNY6FtUF3Q", "IK2eD1nvSP-L3yilE6K7BQ", "iZ8qUO-MSwuezTn_elPb3g", "gLspcP3NRqmdOm615HSTig", "HYKxh1JfTcyUhTgJxAxfWg", "1RkJixj_QKOg_c7G_wGIZA", "LiPzVuKnT2Go1WWteQkZtw", "V5wXtLilSsWGkMYSiLVy2g", "MseNZ_LBRu63R84k9knIKg" ] } }, "CreateanaccountRequest": { "title": "CreateanaccountRequest", "example": { "contact": { "first": "John", "last": "Doe", "email": "j.doe@fastspring.com", "company": "FastSpring", "phone": "402-402-4024" }, "language": "en", "country": "US", "lookup": { "custom": "customKey" } }, "type": "object", "properties": { "contact": { "$ref": "#/components/schemas/Contact" }, "language": { "type": "string" }, "country": { "type": "string" }, "lookup": { "$ref": "#/components/schemas/Lookup" } }, "required": [ "contact", "language", "country", "lookup" ] }, "Contact": { "title": "Contact", "example": { "first": "John", "last": "Doe", "email": "j.doe@fastspring.com", "company": "FastSpring", "phone": "402-402-4024" }, "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "first", "last", "email", "company", "phone" ] }, "Lookup": { "title": "Lookup", "example": { "custom": "customKey" }, "type": "object", "properties": { "custom": { "type": "string" } }, "required": [ "custom" ] }, "UpdateexistingaccountRequest": { "title": "UpdateexistingaccountRequest", "example": { "contact": { "first": "John", "last": "Doe", "email": "j.doe@fastspring.com", "company": "FastSpring", "phone": "402-402-4024" }, "language": "en", "country": "US", "lookup": { "custom": "customKey" } }, "type": "object", "properties": { "contact": { "$ref": "#/components/schemas/Contact" }, "language": { "type": "string" }, "country": { "type": "string" }, "lookup": { "$ref": "#/components/schemas/Lookup" } }, "required": [ "contact", "language", "country", "lookup" ] }, "CreateanewcouponRequest": { "title": "CreateanewcouponRequest", "example": { "coupon": "Black-Friday-2021", "discount": { "hasMultipleDiscounts": true, "discounts": [ { "type": "flat", "amount": { "USD": 10 }, "products": [ "saas-app-annual" ], "discountPeriodCount": null }, { "type": "percent", "percent": 25, "products": [ "saas-app-monthly" ], "discountPeriodCount": 3 } ] }, "combine": false, "reason": { "en": "Black Friday Savings" }, "limit": "", "available": { "start": "2021-11-24 ", "end": "2021-11-29 " }, "codes": [ "BF21", "BL21" ] } }, "Discount": { "title": "Discount", "example": { "type": "flat", "amount": { "USD": 8, "EUR": 1 } }, "type": "object", "properties": { "type": { "type": "string" }, "amount": { "$ref": "#/components/schemas/Amount" } }, "required": [ "type", "amount" ] }, "Amount": { "title": "Amount", "example": { "USD": 8, "EUR": 1 }, "type": "object", "properties": { "USD": { "type": "integer", "format": "int32" }, "EUR": { "type": "integer", "format": "int32" } }, "required": [ "USD", "EUR" ] }, "Reason": { "title": "Reason", "example": { "en": "Your Reason", "de": "Your Reason in German" }, "type": "object", "properties": { "en": { "type": "string" }, "de": { "type": "string" } }, "required": [ "en", "de" ] }, "Available": { "title": "Available", "example": { "start": "2019-12-01", "end": "2019-12-31" }, "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ] }, "UpdateexistingcouponRequest": { "title": "UpdateexistingcouponRequest", "example": { "coupon": "coupon-id", "discount": { "type": "percent", "percent": 20 }, "combine": true, "reason": { "en": "String", "de": "String" }, "limit": 10, "available": { "start": "2015-08-15", "end": "2015-09-15" }, "codes": [ "code1", "code2" ], "products": [ "product-id", "another-product-id" ] } }, "AddcouponcodestoacouponRequest": { "title": "AddcouponcodestoacouponRequest", "example": { "codes": [ "code4", "code5", "code6" ] }, "type": "object", "properties": { "codes": { "type": "array", "items": { "type": "string" } } }, "required": [ "codes" ] }, "UpdateasingleeventRequest": { "title": "UpdateasingleeventRequest", "example": { "processed": true }, "type": "object", "properties": { "processed": { "type": "boolean" } }, "required": [ "processed" ] }, "GetOrdersById": { "title": "GetOrdersById", "example": { "order": "oN5eASPKTM2Jwkx15ICNyg", "id": "oN5eASPKTM2Jwkx15ICNyg", "reference": "FUR191015-1265-35113", "buyerReference": null, "ipAddress": "000.000.00.000", "completed": true, "changed": 1571172709980, "changedValue": 1571172709980, "changedInSeconds": 1571172709, "changedDisplay": "10/15/19", "language": "en", "live": false, "currency": "USD", "payoutCurrency": "USD", "invoiceUrl": "https://yourexamplestore.onfastspring.com/account/order/YES191015-1265-35113/invoice", "account": "N8FjcSWcQNeYCc-suM1O8g", "total": 36.15, "totalDisplay": "$36.15", "totalInPayoutCurrency": 36.15, "totalInPayoutCurrencyDisplay": "$36.15", "tax": 0, "taxDisplay": "$0.00", "taxInPayoutCurrency": 0, "taxInPayoutCurrencyDisplay": "$0.00", "subtotal": 36.15, "subtotalDisplay": "$36.15", "subtotalInPayoutCurrency": 36.15, "subtotalInPayoutCurrencyDisplay": "$36.15", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "discountWithTax": 0, "discountWithTaxDisplay": "$0.00", "discountWithTaxInPayoutCurrency": 0, "discountWithTaxInPayoutCurrencyDisplay": "$0.00", "billDescriptor": "FS* YOUREXAMPLESTORE", "payment": { "type": "test", "creditCard": "visa", "cardEnding": "4242", "bank": "sofort" }, "customer": { "first": "Leeroy", "last": "Jenkins", "email": "ne1@all.com", "company": null, "phone": null }, "address": { "addressLine1": "801 Garden St.", "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" }, "recipients": [ { "recipient": { "first": "Leeroy", "last": "Jenkins", "email": "ne1@all.com", "company": null, "phone": null, "account": "N8FjcSWcQNeYCc-suM1O8g", "address": { "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" } } } ], "notes": [], "items": [ { "product": "example-monthly-subscription", "quantity": 1, "display": "Example Monthly Subscription", "sku": "exsub1", "subtotal": 14.95, "subtotalDisplay": "$14.95", "subtotalInPayoutCurrency": 14.95, "subtotalInPayoutCurrencyDisplay": "$14.95", "attributes": { "CustomAttribute1": "CustomValue1", "CustomAttribute2": "CustomValue2", "key": "value" }, "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "coupon": "FREE", "subscription": "73lsX5kvRsWKLzwRNMkcow", "fulfillments": { "example-monthly-subscription_file_0": [ { "display": "EXAMPLE.exe", "size": 129, "file": "https://yourexamplestore.onfastspring.com/account/file/YES191015-1265-46134F", "type": "file" } ], "example-monthly-subscription_license_1": [ { "license": "s5cMEOpM0zP5KQqD5Wps", "display": "License Key", "type": "license" } ], "instructions": "Thank you for subscribing to Example Monthly Subscription." }, "taxWithholding": { "taxWithholding": "true", "currency": "USD", "amount": 23.34, "percentage": 5 } }, { "product": "example-product-2", "quantity": 1, "display": "Example Product 2", "sku": "exprod2", "subtotal": 9.95, "subtotalDisplay": "$9.95", "subtotalInPayoutCurrency": 9.95, "subtotalInPayoutCurrencyDisplay": "$9.95", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "coupon": "FREE", "fulfillments": { "example-product-2_license_0": [ { "license": "ejTUv8dpuJWZQ5lMN6YE", "display": "License Key", "type": "license" } ], "example-product-2_file_1": [ { "display": "EXAMPLE2.exe", "size": 5769, "file": "https://yourexamplestore.onfastspring.com/account/file/YES191015-1265-67116F", "type": "file" } ] }, "taxWithholding": { "taxWithholding": "true", "currency": "USD", "amount": 23.34, "percentage": 5 }, "driver": { "type": "addon", "path": "example-monthly-subscription" } }, { "product": "example-monthly-subscription.setupFee", "quantity": 1, "display": "One-time Setup Fee", "sku": null, "subtotal": 10, "subtotalDisplay": "$10.00", "subtotalInPayoutCurrency": 10, "subtotalInPayoutCurrencyDisplay": "$10.00", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "coupon": "FREE", "fulfillments": {}, "taxWithholding": { "taxWithholding": "true", "currency": "USD", "amount": 23.34, "percentage": 5 }, "driver": { "type": "one_time_fee", "path": "example-monthly-subscription" } }, { "product": "example-product-3", "quantity": 1, "display": "Example Product 3", "sku": "exprod3", "subtotal": 1.25, "subtotalDisplay": "$1.25", "subtotalInPayoutCurrency": 1.25, "subtotalInPayoutCurrencyDisplay": "$1.25", "attributes": { "conditions": "{exclude:{countries:['AT','GB']}}" }, "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "coupon": "FREE", "fulfillments": { "example-product-3_file_1": [ { "display": "EXAMPLE3.exe", "size": 5769, "file": "https://yourexamplestore.onfastspring.com/account/file/YES191015-1265-14137F", "type": "file" } ], "instructions": "Thank you for purchasing Example Product 3. To register, please launch the trial version and select Help -> Register Example Product 3. Then, copy and paste the license key below into the License Key field and click Submit." }, "taxWithholding": { "taxWithholding": "true", "currency": "USD", "amount": 23.34, "percentage": 5 }, "driver": { "type": "cross-sell", "path": "example-monthly-subscription" } } ] } }, "GetOrdersByIdError": { "title": "GetOrdersByIdError", "example": { "orders": [ { "action": "order.get", "order": "zSprqRHITGeW0kSGC7AKmh", "result": "error", "error": { "order": "Not found" } } ] } }, "GetOrdersByDates": { "title": "GetOrdersByDates", "example": { "action": "order.lookup", "result": "success", "begin": "6/1/16", "end": "8/30/16", "page": 4, "limit": 30, "nextPage": 5, "total": 1048, "orders": [ { "order": "Qf1jNhlCSKGW5RJdfM7cTg", "id": "Qf1jNhlCSKGW5RJdfM7cTg", "reference": "FUR160824-6097-31167", "buyerReference": null, "ipAddress": "000.000.00.000", "completed": true, "changed": 1472061802969, "changedValue": 1472061802969, "changedInSeconds": 1472061802, "changedDisplay": "8/24/16", "language": "en", "live": false, "currency": "USD", "account": "cZnOkAUIQ2qCtcrTtyXgYQ", "payoutCurrency": "USD", "invoiceUrl": "https://yourexamplestore.onfastspring.com/account/order/YES160824-6097-31167/invoice", "total": 19.44, "totalDisplay": "$19.44", "totalInPayoutCurrency": 19.44, "totalInPayoutCurrencyDisplay": "$19.44", "tax": 1.44, "taxDisplay": "$1.44", "taxInPayoutCurrency": 1.44, "taxInPayoutCurrencyDisplay": "$1.44", "subtotal": 18, "subtotalDisplay": "$18.00", "subtotalInPayoutCurrency": 18, "subtotalInPayoutCurrencyDisplay": "$18.00", "discount": 2, "discountDisplay": "$2.00", "discountInPayoutCurrency": 2, "discountInPayoutCurrencyDisplay": "$2.00", "discountWithTax": 2.16, "discountWithTaxDisplay": "$2.16", "discountWithTaxInPayoutCurrency": 2.16, "discountWithTaxInPayoutCurrencyDisplay": "$2.16", "payment": { "type": "free", "creditcard": "visa", "cardEnding": "4242", "bank": "sofort" }, "customer": { "first": "Reenable", "last": "MailingList", "email": "ne1@all.com", "company": null, "phone": "1234567890" }, "address": { "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" }, "recipients": [ { "recipient": { "first": "Reenable", "last": "MailingList", "email": "ne1@all.com", "company": null, "phone": "1234567890", "account": "KJRTYQByS_WIcVQ-AZp6kw", "address": { "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" } } } ], "notes": [], "items": [ { "product": "physical", "quantity": 1, "display": "Physical", "sku": null, "subtotal": 9, "subtotalDisplay": "$9.00", "subtotalInPayoutCurrency": 9, "subtotalInPayoutCurrencyDisplay": "$9.00", "attributes": { "SystemExtension.eds": "true" }, "discount": 1, "discountDisplay": "$1.00", "discountInPayoutCurrency": 1, "discountInPayoutCurrencyDisplay": "$1.00", "coupon": "TEST", "fulfillments": { "physical_file_0": [ { "display": "malware.zip", "size": 4106, "file": "https://yourexamplestore.onfastspring.com/account/file/YES160824-6097-46172F", "type": "file" } ] } }, { "product": "SystemExtension.eds", "quantity": 1, "display": "EDS", "sku": null, "subtotal": 9, "subtotalDisplay": "$9.00", "subtotalInPayoutCurrency": 9, "subtotalInPayoutCurrencyDisplay": "$9.00", "attributes": { "SystemExtension.eds": "true" }, "discount": 1, "discountDisplay": "$1.00", "discountInPayoutCurrency": 1, "discountInPayoutCurrencyDisplay": "$1.00", "coupon": "TEST", "fulfillments": {} } ], "coupons": [ "TEST" ] } ] } }, "GetOrdersByDatesError": { "title": "GetOrdersByDatesError", "example": { "action": "order.lookup", "result": "error", "error": { "begin": "Invalid begin date", "end": "End date must be after begin date" } } }, "GetOrdersByEndDate": { "title": "GetOrdersByEndDate", "example": { "action": "order.lookup", "result": "success", "end": "6/30/16", "page": 1, "limit": 50, "nextPage": null, "total": 9, "orders": [ { "order": "US5oKN5sRU2OUWxVwivl_Q", "id": "US5oKN5sRU2OUWxVwivl_Q", "reference": "FUR160629-3229-57108B", "buyerReference": null, "ipAddress": "000.000.00.000", "completed": true, "changed": 1467239032151, "changedValue": 1467239032151, "changedInSeconds": 1467239032, "changedDisplay": "6/29/16", "language": "en", "live": false, "currency": "USD", "account": "E93cH9zLS6ebdnrUjCYLFA", "payoutCurrency": "USD", "invoiceUrl": "https://yourexamplestore.onfastspring.com/account/order/YES160629-3229-57108B/invoice", "total": 10, "totalDisplay": "USD 10.00", "totalInPayoutCurrency": 10, "totalInPayoutCurrencyDisplay": "USD 10.00", "tax": 0, "taxDisplay": "USD 0.00", "taxInPayoutCurrency": 0, "taxInPayoutCurrencyDisplay": "USD 0.00", "subtotal": 10, "subtotalDisplay": "USD 10.00", "subtotalInPayoutCurrency": 10, "subtotalInPayoutCurrencyDisplay": "USD 10.00", "discount": 0, "discountDisplay": "USD 0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "USD 0.00", "discountWithTax": 0, "discountWithTaxDisplay": "USD 0.00", "discountWithTaxInPayoutCurrency": 0, "discountWithTaxInPayoutCurrencyDisplay": "USD 0.00", "payment": { "type": "free", "creditcard": "visa", "cardEnding": "4242", "bank": "sofort" }, "customer": { "first": "test", "last": "test", "email": "ne1@all.com", "company": null, "phone": "1234567890" }, "address": { "addressLine1": "272 Gonghang-ro", "city": "Jung-gu", "region": "Incheon", "postalCode": "40765", "country": "KR", "display": "272 Gonghang-ro, Jung-gu, Incheon, 40765, KR" }, "recipients": [ { "recipient": { "first": "test", "last": "test", "email": "ne1@all.com", "company": null, "phone": 1234567890, "account": "E93cH9zLS6ebdnrUjCYLFA", "address": { "addressLine1": "272 Gonghang-ro", "city": "Jung-gu", "region": "Incheon", "postalCode": "40765", "country": "KR", "display": "272 Gonghang-ro, Jung-gu, Incheon, 40765, KR" } } } ], "notes": [], "items": [ { "product": "firstsub", "quantity": 1, "display": "firstSub", "sku": null, "subtotal": 10, "subtotalDisplay": "USD 10.00", "subtotalInPayoutCurrency": 10, "subtotalInPayoutCurrencyDisplay": "USD 10.00", "discount": 0, "discountDisplay": "USD 0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "USD 0.00", "subscription": "1hrkNaKxRyizVyj_Lv9RCA" } ] } ] } }, "GetOrdersWithReturnOnly": { "title": "GetOrdersWithReturnOnly", "example": { "action": "order.lookup", "result": "success", "begin": "7/16/18", "end": "7/17/18", "page": 1, "limit": 50, "nextPage": null, "total": 1, "orders": [ { "order": "sLvABUuPTOmxuxxme6zyBA", "id": "sLvABUuPTOmxuxxme6zyBA", "reference": "FUR180716-1320-39108", "buyerReference": null, "ipAddress": "000.000.00.000", "completed": true, "changed": 1531768631874, "changedValue": 1531768631874, "changedInSeconds": 1531768631, "changedDisplay": "7/16/18", "language": "en", "live": false, "currency": "USD", "payoutCurrency": "USD", "invoiceUrl": "https://yourexamplestore.onfastspring.com/account/order/YES180716-1320-39108/invoice", "account": "5ta9yueaQ2mlc3UeSZi2Ew", "total": 59.99, "totalDisplay": "USD 59.99", "totalInPayoutCurrency": 59.99, "totalInPayoutCurrencyDisplay": "USD 59.99", "tax": 0, "taxDisplay": "USD 0.00", "taxInPayoutCurrency": 0, "taxInPayoutCurrencyDisplay": "USD 0.00", "subtotal": 59.99, "subtotalDisplay": "USD 59.99", "subtotalInPayoutCurrency": 59.99, "subtotalInPayoutCurrencyDisplay": "USD 59.99", "discount": 0, "discountDisplay": "USD 0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "USD 0.00", "discountWithTax": 0, "discountWithTaxDisplay": "USD 0.00", "discountWithTaxInPayoutCurrency": 0, "discountWithTaxInPayoutCurrencyDisplay": "USD 0.00", "billDescriptor": "FS* fsprg.com", "payment": { "type": "test", "cardEnding": "4242" }, "customer": { "first": "John", "last": "Doe", "email": "ne1@all.com", "company": null, "phone": null }, "address": { "addressLine1": "123 Elm St", "city": "Lisbon", "regionDisplay": "", "region": "", "postalCode": "93101", "country": "DE", "display": "123 Elm St, Lisbon, , 93101, DE" }, "recipients": [ { "recipient": { "first": "John", "last": "Doe", "email": "ne1@all.com", "company": null, "phone": null, "account": "5ta9yueaQ2mlc3UeSZi2Ew", "address": { "addressLine1": "123 Elm St", "city": "Lisbon", "regionDisplay": "", "region": "", "postalCode": "93101", "country": "DE", "display": "123 Elm St, Lisbon, , 93101, DE" } } } ], "notes": [], "items": [ { "product": "example-product-1", "quantity": 1, "display": "Example Product 1", "sku": "exprod1", "subtotal": 59.99, "subtotalDisplay": "USD 59.99", "subtotalInPayoutCurrency": 59.99, "subtotalInPayoutCurrencyDisplay": "USD 59.99", "discount": 0, "discountDisplay": "USD 0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "USD 0.00", "fulfillments": { "example-product-1_license_0": [ { "license": "Example-8QEl7sD8FKI56r4siL9c", "display": "License Key", "type": "license" } ], "example-product-1_file_2": [ { "display": "EXAMPLE.EXE", "size": 129, "file": "https://yourexamplestore.onfastspring.com/account/file/YES180716-1320-64112F", "type": "file" } ], "instructions": "Thank you for purchasing Example Product 1." } } ], "returns": [ { "return": "YxCkQcnTR_iX1iZJgQly8Q", "amount": 59.99, "amountDisplay": "USD 59.99", "amountInPayoutCurrency": 59.99, "amountInPayoutCurrencyDisplay": "USD 59.99" } ] } ] } }, "UpdateOrderTags": { "title": "UpdateOrderTags", "example": { "orders": [ { "order": "JL4ltRyBSTS0myETu7yJIA", "tags": { "TagKey1": "TagValue1", "TagKey2": "TagValue2" }, "items": [ { "product": "product-path", "attributes": { "AttributeKey1": "AttributeValue1", "AttributeKey2": "AttributeValue2" } } ] } ] } }, "UpdateOrderTagsResponse": { "title": "UpdateOrderTagsResponse", "example": { "orders": [ { "action": "order.update", "order": "[0]", "result": "error", "error": { "order": "Not found" } } ] } }, "UpdateOrderTagsResponse2": { "title": "UpdateOrderTagsResponse2", "example": { "orders": [ { "action": "order.update", "order": "JL4ltRyBSTS0myETu7yJIA", "result": "error", "error": { "items.example-product-2": "Product is not specified as a valid item in the order" } } ] } }, "GetOrdersByProductPathDates": { "title": "GetOrdersByProductPathDates", "example": { "action": "order.lookup", "result": "success", "begin": "6/1/16", "end": "7/30/16", "page": 1, "limit": 10, "nextPage": null, "total": 5, "orders": [ { "order": "sHwVlGLER9qJHKr6lkX5oA", "id": "sHwVlGLER9qJHKr6lkX5oA", "reference": "FUR160710-2490-94117", "buyerReference": null, "ipAddress": "000.000.00.000", "completed": true, "changed": 1468120080887, "changedValue": 1468120080887, "changedInSeconds": 1468120080, "changedDisplay": "7/10/16", "language": "en", "live": false, "currency": "USD", "account": "E93cH9zLS6ebdnrUjCYLFA", "payoutCurrency": "USD", "invoiceUrl": "https://yourexamplestore.onfastspring.com/account/order/YES160710-2490-94117/invoice", "total": 66.96, "totalDisplay": "$66.96", "totalInPayoutCurrency": 66.96, "totalInPayoutCurrencyDisplay": "$66.96", "tax": 4.96, "taxDisplay": "$4.96", "taxInPayoutCurrency": 4.96, "taxInPayoutCurrencyDisplay": "$4.96", "subtotal": 62, "subtotalDisplay": "$62.00", "subtotalInPayoutCurrency": 62, "subtotalInPayoutCurrencyDisplay": "$62.00", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "discountWithTax": 0, "discountWithTaxDisplay": "$0.00", "discountWithTaxInPayoutCurrency": 0, "discountWithTaxInPayoutCurrencyDisplay": "$0.00", "payment": { "type": "free", "creditcard": "visa", "cardEnding": "4242", "bank": "sofort" }, "customer": { "first": "test", "last": "order", "email": "ne1@all.com", "company": null, "phone": "1234567890" }, "address": { "addressLine1": "801 Garden Street", "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" }, "recipients": [ { "recipient": { "first": "New", "last": "Order", "email": "ne1@all.com", "company": null, "phone": "1234567890", "account": "KJRTYQByS_WIcVQ-AZp6kw", "address": { "addressLine1": "801 Garden Street", "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" } } } ], "notes": [], "items": [ { "product": "testbundle", "quantity": 3, "display": "TestBundle", "sku": null, "subtotal": 30, "subtotalDisplay": "$30.00", "subtotalInPayoutCurrency": 30, "subtotalInPayoutCurrencyDisplay": "$30.00", "attributes": { "SystemExtension.eds": "true" }, "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "fulfillments": {} }, { "product": "physical", "quantity": 3, "display": "Physical", "sku": null, "subtotal": 0, "subtotalDisplay": "$0.00", "subtotalInPayoutCurrency": 0, "subtotalInPayoutCurrencyDisplay": "$0.00", "attributes": { "SystemExtension.eds": "true" }, "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "fulfillments": { "physical_file_0": [ { "display": "malware.zip", "size": 4106, "file": "https://automation.test.qa.onfastspring.com/account/file/YES160710-2490-43134F", "type": "file" } ] } }, { "product": "firstsub", "quantity": 3, "display": "firstSub", "sku": null, "subtotal": 0, "subtotalDisplay": "$0.00", "subtotalInPayoutCurrency": 0, "subtotalInPayoutCurrencyDisplay": "$0.00", "attributes": { "SystemExtension.eds": "true" }, "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "subscription": "KNj-JrZyQ7i2yALyv5nv7Q", "fulfillments": { "firstsub_license_0": [ { "license": "1", "display": "License Key", "type": "license" } ], "firstsub_file_0": [ { "display": "poty2006.zip", "size": 538835908, "file": "https://automation.test.qa.onfastspring.com/account/file/YES160710-2490-80119F", "type": "file" } ] } }, { "product": "digitalphysical", "quantity": 1, "display": "digitalPhysical", "sku": null, "subtotal": 10, "subtotalDisplay": "$10.00", "subtotalInPayoutCurrency": 10, "subtotalInPayoutCurrencyDisplay": "$10.00", "attributes": { "SystemExtension.eds": "true" }, "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "fulfillments": { "digitalphysical_file_0": [ { "display": "Anaconda2-2.4.1-MacOSX-x86_64.pkg", "size": 257787337, "file": "https://automation.test.qa.onfastspring.com/account/file/YES160710-2490-25147F", "type": "file" } ] } }, { "product": "SystemExtension.shippingcalculation", "quantity": 1, "display": "Shipping", "sku": null, "subtotal": 12, "subtotalDisplay": "$12.00", "subtotalInPayoutCurrency": 12, "subtotalInPayoutCurrencyDisplay": "$12.00", "attributes": { "SystemExtension.eds": "true" }, "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "fulfillments": {} }, { "product": "SystemExtension.eds", "quantity": 1, "display": "EDS", "sku": null, "subtotal": 10, "subtotalDisplay": "$10.00", "subtotalInPayoutCurrency": 10, "subtotalInPayoutCurrencyDisplay": "$10.00", "attributes": { "SystemExtension.eds": "true" }, "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "fulfillments": {} } ] } ] } }, "GetOrdersByProductPath": { "title": "GetOrdersByProductPath", "example": { "action": "order.lookup", "result": "success", "page": 1, "limit": 20, "nextPage": 2, "total": 1006, "orders": [ { "order": "nlqoczuZSaGKzuNNK5IDiQ", "id": "nlqoczuZSaGKzuNNK5IDiQ", "reference": null, "buyerReference": null, "ipAddress": "000.000.00.000", "completed": false, "changed": 1471997419992, "changedValue": 1471997419992, "changedInSeconds": 1471997419, "changedDisplay": "8/24/16", "language": "en", "live": false, "currency": "USD", "account": "KJRTYQByS_WIcVQ-AZp6kw", "payoutCurrency": "USD", "invoiceUrl": "https://yourexamplestore.onfastspring.com/account/order/null/invoice", "total": 10, "totalDisplay": "$10.00", "totalInPayoutCurrency": 10, "totalInPayoutCurrencyDisplay": "$10.00", "tax": 0, "taxDisplay": "$0.00", "taxInPayoutCurrency": 0, "taxInPayoutCurrencyDisplay": "$0.00", "subtotal": 10, "subtotalDisplay": "$10.00", "subtotalInPayoutCurrency": 10, "subtotalInPayoutCurrencyDisplay": "$10.00", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "discountWithTax": 0, "discountWithTaxDisplay": "$0.00", "discountWithTaxInPayoutCurrency": 0, "discountWithTaxInPayoutCurrencyDisplay": "$0.00", "payment": {}, "customer": { "first": "New", "last": "Order", "email": "ne1@all.com", "company": null, "phone": "1234567890" }, "address": { "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" }, "recipients": [ { "recipient": { "first": "New", "last": "Order", "email": "ne1@all.com", "company": null, "phone": "1234567890", "account": "KJRTYQByS_WIcVQ-AZp6kw", "address": { "city": "Santa Barbara", "regionCode": "CA", "regionDisplay": "California", "region": "California", "postalCode": "93101", "country": "US", "display": "Santa Barbara, California, 93101, US" } } } ], "notes": [], "items": [ { "product": "suba", "quantity": 1, "display": "PaymentReminderBeforeUpdate", "sku": "SKU111", "subtotal": 10, "subtotalDisplay": "$10.00", "subtotalInPayoutCurrency": 10, "subtotalInPayoutCurrencyDisplay": "$10.00", "discount": 0, "discountDisplay": "$0.00", "discountInPayoutCurrency": 0, "discountInPayoutCurrencyDisplay": "$0.00", "subscription": "YDnZ-ExrQ3mWe0YTmSsQaQ" } ] } ] } }, "CreateneworderandcompletethechargeRequest": { "title": "CreateneworderandcompletethechargeRequest", "example": { "account": "{account_id}", "coupon": "", "tags": { "tag1": "value1" }, "currency": "USD", "items": [ { "product": "{product_id}", "quantity": 1, "pricing": { "trial": 0, "renew": "auto", "interval": "month", "intervalLength": 1, "quantityBehavior": "allow", "quantityDefault": 1, "price": { "USD": 14.95, "EUR": 10.99 } }, "attributes": { "ATTRIBUTE1": "value1" } } ] }, "type": "object", "properties": { "account": { "type": "string" }, "coupon": { "type": "string" }, "tags": { "$ref": "#/components/schemas/Tags" }, "currency": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } } }, "required": [ "account", "coupon", "tags", "currency", "items" ] }, "Tags": { "title": "Tags", "example": { "tag1": "value1" }, "type": "object", "properties": { "tag1": { "type": "string" } }, "required": [ "tag1" ] }, "Item": { "title": "Item", "example": { "product": "{product_id}", "quantity": 1, "pricing": { "trial": 0, "renew": "auto", "interval": "month", "intervalLength": 1, "quantityBehavior": "allow", "quantityDefault": 1, "price": { "USD": 14.95, "EUR": 10.99 } }, "attributes": { "ATTRIBUTE1": "value1" } }, "type": "object", "properties": { "product": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "pricing": { "$ref": "#/components/schemas/Pricing" }, "attributes": { "$ref": "#/components/schemas/Attributes" } }, "required": [ "product", "quantity", "pricing", "attributes" ] }, "Pricing": { "title": "Pricing", "example": { "trial": 0, "renew": "auto", "interval": "month", "intervalLength": 1, "quantityBehavior": "allow", "quantityDefault": 1, "price": { "USD": 14.95, "EUR": 10.99 } }, "type": "object", "properties": { "trial": { "type": "integer", "format": "int32" }, "renew": { "type": "string" }, "interval": { "type": "string" }, "intervalLength": { "type": "integer", "format": "int32" }, "quantityBehavior": { "type": "string" }, "quantityDefault": { "type": "integer", "format": "int32" }, "price": { "$ref": "#/components/schemas/Price" } }, "required": [ "trial", "renew", "interval", "intervalLength", "quantityBehavior", "quantityDefault", "price" ] }, "Price": { "title": "Price", "example": { "USD": 14.95, "EUR": 10.99 }, "type": "object", "properties": { "USD": { "type": "number", "format": "double" }, "EUR": { "type": "number", "format": "double" } }, "required": [ "USD", "EUR" ] }, "Attributes": { "title": "Attributes", "example": { "ATTRIBUTE1": "value1" }, "type": "object", "properties": { "ATTRIBUTE1": { "type": "string" } }, "required": [ "ATTRIBUTE1" ] }, "UpdateordertagsandattributesRequest": { "title": "UpdateordertagsandattributesRequest", "example": { "orders": [ { "order": "{order_id}", "tags": { "TagKey1": "TagValue1", "TagKey2": "TagValue2" }, "items": [ { "product": "product_id}", "attributes": { "AttributeKey1": "AttributeValue1", "AttributeKey2": "AttributeValue2" } } ] } ] }, "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } }, "required": [ "orders" ] }, "Order": { "title": "Order", "example": { "order": "{order_id}", "tags": { "TagKey1": "TagValue1", "TagKey2": "TagValue2" }, "items": [ { "product": "product_id}", "attributes": { "AttributeKey1": "AttributeValue1", "AttributeKey2": "AttributeValue2" } } ] }, "type": "object", "properties": { "order": { "type": "string" }, "tags": { "$ref": "#/components/schemas/Tags1" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Item1" } } }, "required": [ "order", "tags", "items" ] }, "Tags1": { "title": "Tags1", "example": { "TagKey1": "TagValue1", "TagKey2": "TagValue2" }, "type": "object", "properties": { "TagKey1": { "type": "string" }, "TagKey2": { "type": "string" } }, "required": [ "TagKey1", "TagKey2" ] }, "Item1": { "title": "Item1", "example": { "product": "product_id}", "attributes": { "AttributeKey1": "AttributeValue1", "AttributeKey2": "AttributeValue2" } }, "type": "object", "properties": { "product": { "type": "string" }, "attributes": { "$ref": "#/components/schemas/Attributes1" } }, "required": [ "product", "attributes" ] }, "Attributes1": { "title": "Attributes1", "example": { "AttributeKey1": "AttributeValue1", "AttributeKey2": "AttributeValue2" }, "type": "object", "properties": { "AttributeKey1": { "type": "string" }, "AttributeKey2": { "type": "string" } }, "required": [ "AttributeKey1", "AttributeKey2" ] }, "GetProductsByPth": { "title": "GetProductsByPth", "example": { "application/json": { "products": [ { "product": "{product_path}", "parent": null, "productAppReference": "QwEYIcPgTvaet2-pKLC9yU", "display": { "en": "product_name" }, "offers": [ { "type": "addon", "display": {}, "items": [ "product_item" ] } ], "fulfillments": { "sub-auto-addon_file_0": { "fulfillment": "product_file", "name": "File Download (signed.pdf)", "applicability": "NON_REBILL_ONLY", "display": null, "url": null, "size": null, "behavior": "PREFER_EXPLICIT", "previous": [] } }, "format": "digital", "taxcode": "DC020501", "taxcodeDescription": "Computer Software - educational - prewritten/canned - electronically downloaded", "pricing": { "interval": "month", "intervalLength": 1, "intervalCount": null, "quantityBehavior": "allow", "quantityDefault": 1, "price": { "USD": 100 }, "dateLimitsEnabled": false, "reminderNotification": { "enabled": true, "interval": "week", "intervalLength": 1 }, "overdueNotification": { "enabled": true, "interval": "week", "intervalLength": 1, "amount": 4 }, "cancellation": { "interval": "week", "intervalLength": 1 } }, "action": "products.get", "result": "success" } ] } } }, "GetAllProducts": { "title": "GetAllProducts", "example": { "action": "products.getall", "result": "success", "page": null, "limit": null, "nextPage": null, "total": 0, "products": [ "product_path", "product_path", "...", "product_path" ] } }, "GetAllProductsPrice": { "title": "GetAllProductsPrice", "example": { "page": 1, "limit": 50, "nextPage": 2, "products": [ { "action": "product.price.getall", "result": "success", "product": "example-subscription", "pricing": { "PR": { "2": { "discountPercent": 5, "discountValue": 5, "discountValueDisplay": "$5.00", "unitPrice": 95, "unitPriceDisplay": "$95.00" }, "3": { "discountPercent": 10, "discountValue": 10, "discountValueDisplay": "$10.00", "unitPrice": 90, "unitPriceDisplay": "$90.00" }, "4": { "discountPercent": 15, "discountValue": 15, "discountValueDisplay": "$15.00", "unitPrice": 85, "unitPriceDisplay": "$85.00" }, "5": { "discountPercent": 25, "discountValue": 25, "discountValueDisplay": "$25.00", "unitPrice": 75, "unitPriceDisplay": "$75.00" }, "currency": "USD", "price": 100, "display": "$100.00", "quantityDiscount": null, "discountReason": { "en": "2023 Yearly Sale" }, "discountPeriodCount": "null", "available": { "start": "2023-01-01 00:00", "end": "2023-12-31 23:30" }, "setupFeePrice": "10.0,", "setupFeePriceDisplay": "$10.00", "setupFeeReason": { "en": "Setup Fee" } }, "DE": { "2": { "discountPercent": 5, "discountValue": 4.5, "discountValueDisplay": "4,50 €", "unitPrice": 85, "unitPriceDisplay": "85,50 €" }, "3": { "discountPercent": 10, "discountValue": 9, "discountValueDisplay": "9,00 €", "unitPrice": 81, "unitPriceDisplay": "81,00 €" }, "4": { "discountPercent": 15, "discountValue": 13.5, "discountValueDisplay": "13,50 €", "unitPrice": 76.5, "unitPriceDisplay": "76,50 €" }, "5": { "discountPercent": 25, "discountValue": 22.5, "discountValueDisplay": "$22.50", "unitPrice": 67.5, "unitPriceDisplay": "$67.50" }, "currency": "EUR", "price": 90, "display": "90,00 €", "quantityDiscount": null, "discountReason": { "en": "2023 Yearly Sale" }, "discountPeriodCount": "null", "available": { "start": "2023-01-01 00:00", "end": "2023-12-31 23:30" }, "setupFeePrice": "11.0,", "setupFeePriceDisplay": "12,00 €", "setupFeeReason": { "en": "Setup Fee" } } } } ] } }, "GetProductPrice": { "title": "GetProductPrice", "example": { "page": 1, "limit": 50, "nextPage": 2, "products": [ { "action": "product.price.get", "result": "success", "product": "example-subscription", "pricing": { "PR": { "2": { "discountPercent": 5, "discountValue": 5, "discountValueDisplay": "$5.00", "unitPrice": 95, "unitPriceDisplay": "$95.00" }, "3": { "discountPercent": 10, "discountValue": 10, "discountValueDisplay": "$10.00", "unitPrice": 90, "unitPriceDisplay": "$90.00" }, "4": { "discountPercent": 15, "discountValue": 15, "discountValueDisplay": "$15.00", "unitPrice": 85, "unitPriceDisplay": "$85.00" }, "5": { "discountPercent": 25, "discountValue": 25, "discountValueDisplay": "$25.00", "unitPrice": 75, "unitPriceDisplay": "$75.00" }, "currency": "USD", "price": 100, "display": "$100.00", "quantityDiscount": null, "discountReason": { "en": "2023 Yearly Sale" }, "discountPeriodCount": "null", "available": { "start": "2023-01-01 00:00", "end": "2023-12-31 23:30" }, "setupFeePrice": "10.0,", "setupFeePriceDisplay": "$10.00", "setupFeeReason": { "en": "Setup Fee" } }, "DE": { "2": { "discountPercent": 5, "discountValue": 4.5, "discountValueDisplay": "4,50 €", "unitPrice": 85, "unitPriceDisplay": "85,50 €" }, "3": { "discountPercent": 10, "discountValue": 9, "discountValueDisplay": "9,00 €", "unitPrice": 81, "unitPriceDisplay": "81,00 €" }, "4": { "discountPercent": 15, "discountValue": 13.5, "discountValueDisplay": "13,50 €", "unitPrice": 76.5, "unitPriceDisplay": "76,50 €" }, "5": { "discountPercent": 25, "discountValue": 22.5, "discountValueDisplay": "$22.50", "unitPrice": 67.5, "unitPriceDisplay": "$67.50" }, "currency": "EUR", "price": 90, "display": "90,00 €", "quantityDiscount": null, "discountReason": { "en": "2023 Yearly Sale" }, "discountPeriodCount": "null", "available": { "start": "2023-01-01 00:00", "end": "2023-12-31 23:30" }, "setupFeePrice": "11.0,", "setupFeePriceDisplay": "12,00 €", "setupFeeReason": { "en": "Setup Fee" } } } } ] } }, "CreateProductsResponse": { "title": "CreateProductsResponse", "example": { "products": [ { "product": "product-path", "action": "product.create", "result": "success" } ] } }, "UpdateProductsResponse": { "title": "UpdateProductsResponse", "example": { "products": [ { "product": "product-path", "action": "product.updated", "result": "success" } ] } }, "CreateProductsResponseError": { "title": "CreateProductsResponseError", "example": { "products": [ { "product": "product-path", "action": "product.create", "result": "error", "error": { "setupFee": "Cannot be applied when a free trial without payment method required is set up", "trialPrice": "price must be defined \"USD\" price may not be zero or less" } } ] } }, "CreateoneormorenewproductsRequest": { "title": "CreateoneormorenewproductsRequest", "example": { "products": [ { "product": "{product_path}", "display": { "en": "String" }, "description": { "summary": { "en": "String" }, "action": { "en": "String" }, "full": { "en": "String" } }, "fulfillment": { "instructions": { "en": "String", "es": "String" } }, "image": "https://d8y8nchqlnmka.cloudfront.net/NVaGM-nhSpQ/-FooqIP-R84/photio-imac-hero.png", "format": "digital", "sku": "string", "attributes": { "key1": "value1", "key2": "value2" }, "pricing": { "trial": 2, "interval": "month", "intervalLength": 1, "quantityBehavior": "allow", "quantityDefault": 1, "paymentCollected": true, "paidTrial": true, "trialPrice": { "USD": 21.99, "EUR": 19.99 }, "price": { "USD": 14.95, "EUR": 10.99 }, "quantityDiscounts": { "10": 25 }, "discountReason": { "en": "The Reason" }, "discountDuration": 1 } } ] }, "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "required": [ "products" ] }, "Product": { "title": "Product", "example": { "product": "{product_path}", "display": { "en": "String" }, "description": { "summary": { "en": "String" }, "action": { "en": "String" }, "full": { "en": "String" } }, "fulfillment": { "instructions": { "en": "String", "es": "String" } }, "image": "https://d8y8nchqlnmka.cloudfront.net/NVaGM-nhSpQ/-FooqIP-R84/photio-imac-hero.png", "format": "digital", "sku": "string", "attributes": { "key1": "value1", "key2": "value2" }, "pricing": { "trial": 2, "interval": "month", "intervalLength": 1, "quantityBehavior": "allow", "quantityDefault": 1, "price": { "USD": 14.95, "EUR": 10.99 }, "quantityDiscounts": { "10": 25 }, "discountReason": { "en": "The Reason" }, "discountDuration": 1 } }, "type": "object", "properties": { "product": { "type": "string" }, "display": { "$ref": "#/components/schemas/Display" }, "description": { "$ref": "#/components/schemas/Description" }, "fulfillment": { "$ref": "#/components/schemas/Fulfillment" }, "image": { "type": "string" }, "format": { "type": "string" }, "sku": { "type": "string" }, "attributes": { "$ref": "#/components/schemas/Attributes2" }, "pricing": { "$ref": "#/components/schemas/Pricing1" } }, "required": [ "product", "display", "description", "fulfillment", "image", "format", "sku", "attributes", "pricing" ] }, "Display": { "title": "Display", "example": { "en": "String" }, "type": "object", "properties": { "en": { "type": "string" } }, "required": [ "en" ] }, "Description": { "title": "Description", "example": { "summary": { "en": "String" }, "action": { "en": "String" }, "full": { "en": "String" } }, "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/Summary" }, "action": { "$ref": "#/components/schemas/Action" }, "full": { "$ref": "#/components/schemas/Full" } }, "required": [ "summary", "action", "full" ] }, "Summary": { "title": "Summary", "example": { "en": "String" }, "type": "object", "properties": { "en": { "type": "string" } }, "required": [ "en" ] }, "Action": { "title": "Action", "example": { "en": "String" }, "type": "object", "properties": { "en": { "type": "string" } }, "required": [ "en" ] }, "Full": { "title": "Full", "example": { "en": "String" }, "type": "object", "properties": { "en": { "type": "string" } }, "required": [ "en" ] }, "Fulfillment": { "title": "Fulfillment", "example": { "instructions": { "en": "String", "es": "String" } }, "type": "object", "properties": { "instructions": { "$ref": "#/components/schemas/Instructions" } }, "required": [ "instructions" ] }, "Instructions": { "title": "Instructions", "example": { "en": "String", "es": "String" }, "type": "object", "properties": { "en": { "type": "string" }, "es": { "type": "string" } }, "required": [ "en", "es" ] }, "Attributes2": { "title": "Attributes2", "example": { "key1": "value1", "key2": "value2" }, "type": "object", "properties": { "key1": { "type": "string" }, "key2": { "type": "string" } }, "required": [ "key1", "key2" ] }, "Pricing1": { "title": "Pricing1", "example": { "trial": 2, "interval": "month", "intervalLength": 1, "quantityBehavior": "allow", "quantityDefault": 1, "price": { "USD": 14.95, "EUR": 10.99 }, "quantityDiscounts": { "10": 25 }, "discountReason": { "en": "The Reason" }, "discountDuration": 1 }, "type": "object", "properties": { "trial": { "type": "integer", "format": "int32" }, "interval": { "type": "string" }, "intervalLength": { "type": "integer", "format": "int32" }, "quantityBehavior": { "type": "string" }, "quantityDefault": { "type": "integer", "format": "int32" }, "paymentCollected": { "type": "boolean" }, "paidTrial": { "type": "boolean" }, "trialPrice": { "$ref": "#/components/schemas/Price" }, "price": { "$ref": "#/components/schemas/Price" }, "quantityDiscounts": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "discountReason": { "$ref": "#/components/schemas/DiscountReason" }, "discountDuration": { "type": "integer", "format": "int32" } }, "required": [ "trial", "interval", "intervalLength", "quantityBehavior", "quantityDefault", "price", "quantityDiscounts", "discountReason", "discountDuration" ] }, "DiscountReason": { "title": "DiscountReason", "example": { "en": "The Reason" }, "type": "object", "properties": { "en": { "type": "string" } }, "required": [ "en" ] }, "GetAllAccounts": { "title": "GetAllAccounts", "example": { "action": "account.getall", "result": "success", "accounts": [ "account-id-1", "account-id-2" ] } }, "GetOneAccountError": { "title": "GetOneAccountError", "example": { "action": "account.get", "account": "wjnkDBJnRcGiOB4Q-3AN9", "result": "error", "error": { "account": "account not found" } } }, "GetOneAccount": { "title": "Getoneaccount", "example": { "accounts": [ { "id": "wjnkDBJnRcGiOB4Q-3AN9w", "account": "wjnkDBJnRcGiOB4Q-3AN9w", "action": "account.get", "contact": { "first": "String", "last": "String", "email": "String", "company": "String", "phone": "String" }, "address": { "addressLine1": "801 Garden St", "addressLine2": "Suite 200", "city": "Santa Barbara", "postalCode": "93101", "region": "CA" }, "language": "en", "country": "US", "lookup": { "global": "K1gb96tBS_yMMLZqKdLXCg", "custom": "customKey" }, "url": "https://store.fastspring.com/storefront/account/K1gb96tBS_yMMLZqKdLXCg", "payment": { "methods": 2, "active": 2 }, "orders": [ "orderId" ], "subscriptions": [ "subscriptionId" ], "charges": [ { "currency": "USD", "total": 10, "payoutCurrency": "USD", "totalInPayoutCurrency": 10, "status": "successful", "order": "6L9YSZ8kRoaFD6DMzVS80Q", "orderReference": "COM151120-4954-44172", "subscription": null, "timestamp": 1448047102396, "timestampValue": 1448047102396, "timestampInSeconds": 1448047102, "timestampDisplay": "11/20/15" } ], "subscribed": true, "result": "success" } ] } }, "CreateOneAccount": { "title": "CreateOneAccount", "example": { "contact": { "first": "String", "last": "String", "email": "String", "company": "String", "phone": "String" }, "language": "en", "country": "US", "lookup": { "custom": "customKey" }, "address": { "addressLine1": "801 Garden St", "addressLine2": "Suite 200", "city": "Santa Barbara", "postalCode": "93101", "region": "CA" } }, "type": "object", "properties": { "contact": { "type": "object", "$ref": "#/components/schemas/ContactRequest" } } }, "CreateOneAccountResponse": { "title": "CreateOneAccountResponse", "example": { "account": "wjnkDBJnRcGiOB4Q-3AN9w", "action": "account.create", "result": "success" } }, "CreateOneAccountError": { "title": "CreateOneAccountError", "example": { "action": "account.create", "result": "error", "error": { "first": "first invalid", "last": "last invalid", "email": "email already exists, /accounts/id", "custom": "custom invalid", "country": "country invalid", "language": "language is invalid" } } }, "AuthenticateAccount": { "title": "AuthenticateAccount", "example": { "accounts": [ { "action": "account.authenticate.get", "result": "success", "account": "YgfM1IwpR4qQItQU5SfFMA", "url": "https://company.onfastspring.com/account/50HsQS1-QcOR3dzEF_rm3w/ydYUZOVrQ24" } ] } }, "AuthenticateAccountError": { "title": "AuthenticateAccountError", "example": { "accounts": [ { "action": "account.authenticate.get", "account": "123", "result": "error", "error": { "account": "Not found" } } ] } }, "LookUpAccount": { "title": "LookUpAccount", "example": { "action": "account.lookup", "result": "success", "accounts": [ { "account": "wjnkDBJnRcGiOB4Q-3AN9w" } ] } }, "LookUpAccountError": { "title": "LookUpAccountError", "example": { "action": "account.lookup", "result": "error", "error": { "custom": "Account not found", "key": "Unrecognized Key", "subscriptions": "Supported value: active, ended, canceled, started", "refunds": "Supported value: true", "begin": "Invalid begin date", "end": "Invalid end date", "AnotherKey": "Only one condition can be specified" } } }, "UpdateoneormoreexistingproductsRequest": { "title": "UpdateoneormoreexistingproductsRequest", "example": { "products": [ { "product": "{product_path}", "display": { "en": "String" }, "description": { "summary": { "en": "String" }, "action": { "en": "String" }, "full": { "en": "String" } }, "fulfillment": { "instructions": { "en": "String", "es": "String" } }, "image": "https://d8y8nchqlnmka.cloudfront.net/NVaGM-nhSpQ/-FooqIP-R84/photio-imac-hero.png", "format": "digital", "sku": "string", "attributes": { "key1": "value1", "key2": "value2" }, "pricing": { "trial": 2, "interval": "month", "intervalLength": 1, "quantityBehavior": "allow", "quantityDefault": 1, "price": { "USD": 14.95, "EUR": 10.99 }, "quantityDiscounts": { "10": 25 }, "discountReason": { "en": "The Reason" }, "discountDuration": 1 } } ] }, "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "required": [ "products" ] }, "CreateasessionwithoutoverridinganydefaultvaluesRequest": { "title": "CreateasessionwithoutoverridinganydefaultvaluesRequest", "example": { "account": "uKj7izONRfanVwBL9eiG_A", "items": [ { "product": "example-monthly-subscription", "quantity": 1, "pricing": { "setupFee": { "title": { "en": "Subscription Initiation Fee" }, "price": { "USD": 10 } } } } ] }, "type": "object", "properties": { "account": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Item2" } } }, "required": [ "account", "items" ] }, "Item2": { "title": "Item2", "example": { "product": "{product_path}", "quantity": 1 }, "type": "object", "properties": { "product": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" } }, "required": [ "product", "quantity" ] }, "CreateasessionoverridingaproductsdefaultpricingRequest": { "title": "CreateasessionoverridingaproductsdefaultpricingRequest", "example": { "account": "{account_id}", "items": [ { "product": "{product_path}", "quantity": 1, "pricing": { "price": { "USD": 10 } } } ] }, "type": "object", "properties": { "account": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Item3" } } }, "required": [ "account", "items" ] }, "Item3": { "title": "Item3", "example": { "product": "{product_path}", "quantity": 1, "pricing": { "price": { "USD": 10 } } }, "type": "object", "properties": { "product": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "pricing": { "$ref": "#/components/schemas/Pricing3" } }, "required": [ "product", "quantity", "pricing" ] }, "Pricing3": { "title": "Pricing3", "example": { "price": { "USD": 10 } }, "type": "object", "properties": { "price": { "$ref": "#/components/schemas/Price3" } }, "required": [ "price" ] }, "Price3": { "title": "Price3", "example": { "USD": 10 }, "type": "object", "properties": { "USD": { "type": "number", "format": "double" } }, "required": [ "USD" ] }, "CreateasessionapplyingacoupontoanorderRequest": { "title": "CreateasessionapplyingacoupontoanorderRequest", "example": { "account": "{account_id}", "items": [ { "product": "{product_path}", "quantity": 1 } ], "coupon": "free" }, "type": "object", "properties": { "account": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Item2" } }, "coupon": { "type": "string" } }, "required": [ "account", "items", "coupon" ] }, "ChangetheproductforanactivesubscriptionRequest": { "title": "ChangetheproductforanactivesubscriptionRequest", "example": { "subscriptions": [ { "subscription": "example-subscription-id", "product": "example-product-path", "quantity": 1, "taxExemptId": "tax-exempt-id" } ] }, "type": "object", "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } }, "required": [ "subscriptions" ] }, "Subscription": { "title": "Subscription", "example": { "subscription": "{subscription_id}", "product": "{subscription_product_path}", "quantity": 1 }, "type": "object", "properties": { "subscription": { "type": "string" }, "product": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "taxExemptId": { "type": "string" } }, "required": [ "subscription", "product", "quantity" ] }, "Subscription1": { "title": "Subscription1", "example": { "subscription": "{subscription_id}", "next": "2019-01-30", "end": 0, "quantity": 2, "coupons": [ "{coupon_id}" ] }, "type": "object", "properties": { "subscription": { "type": "string" }, "next": { "type": "string" }, "end": { "type": "integer", "format": "int32" }, "quantity": { "type": "integer", "format": "int32" }, "coupons": { "type": "array", "items": { "type": "string" } } }, "required": [ "subscription", "next", "end", "quantity", "coupons" ] }, "ChangingthepriceordiscountforanactivesubscriptionRequest": { "title": "ChangingthepriceordiscountforanactivesubscriptionRequest", "example": { "subscriptions": [ { "subscription": "{subscription_id}", "pricing": { "price": { "USD": 10 }, "discount": { "type": "amount", "amount": { "USD": 5 }, "duration": "all" } } } ] }, "type": "object", "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription2" } } }, "required": [ "subscriptions" ] }, "Subscription2": { "title": "Subscription2", "example": { "subscription": "{subscription_id}", "pricing": { "price": { "USD": 10 }, "discount": { "type": "amount", "amount": { "USD": 5 }, "duration": "all" } } }, "type": "object", "properties": { "subscription": { "type": "string" }, "pricing": { "$ref": "#/components/schemas/Pricing4" } }, "required": [ "subscription", "pricing" ] }, "Pricing4": { "title": "Pricing4", "example": { "price": { "USD": 10 }, "discount": { "type": "amount", "amount": { "USD": 5 }, "duration": "all" } }, "type": "object", "properties": { "price": { "$ref": "#/components/schemas/Price4" }, "discount": { "$ref": "#/components/schemas/Discount2" } }, "required": [ "price", "discount" ] }, "Price4": { "title": "Price4", "example": { "USD": 10 }, "type": "object", "properties": { "USD": { "type": "integer", "format": "int32" } }, "required": [ "USD" ] }, "Discount2": { "title": "Discount2", "example": { "type": "amount", "amount": { "USD": 5 }, "duration": "all" }, "type": "object", "properties": { "type": { "type": "string" }, "amount": { "$ref": "#/components/schemas/Amount2" }, "duration": { "type": "string" } }, "required": [ "type", "amount", "duration" ] }, "Amount2": { "title": "Amount2", "example": { "USD": 5 }, "type": "object", "properties": { "USD": { "type": "integer", "format": "int32" } }, "required": [ "USD" ] }, "AddingoreditingasubscriptionaddontoanactivesubscriptionRequest": { "title": "AddingoreditingasubscriptionaddontoanactivesubscriptionRequest", "example": { "subscriptions": [ { "subscription": "{subscription_id}", "addons": [ { "product": "{subscription_addon_path}", "quantity": 2, "pricing": { "price": { "USD": 10 }, "discount": { "type": "percent", "percentage": 10, "duration": 2 } } } ] } ] }, "type": "object", "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription3" } } }, "required": [ "subscriptions" ] }, "Subscription3": { "title": "Subscription3", "example": { "subscription": "{subscription_id}", "addons": [ { "product": "{subscription_addon_path}", "quantity": 2, "pricing": { "price": { "USD": 10 }, "discount": { "type": "percent", "percentage": 10, "duration": 2 } } } ] }, "type": "object", "properties": { "subscription": { "type": "string" }, "addons": { "type": "array", "items": { "$ref": "#/components/schemas/Addon" } } }, "required": [ "subscription", "addons" ] }, "Addon": { "title": "Addon", "example": { "product": "{subscription_addon_path}", "quantity": 2, "pricing": { "price": { "USD": 10 }, "discount": { "type": "percent", "percentage": 10, "duration": 2 } } }, "type": "object", "properties": { "product": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "pricing": { "$ref": "#/components/schemas/Pricing5" } }, "required": [ "product", "quantity", "pricing" ] }, "Pricing5": { "title": "Pricing5", "example": { "price": { "USD": 10 }, "discount": { "type": "percent", "percentage": 10, "duration": 2 } }, "type": "object", "properties": { "price": { "$ref": "#/components/schemas/Price4" }, "discount": { "$ref": "#/components/schemas/Discount3" } }, "required": [ "price", "discount" ] }, "Discount3": { "title": "Discount3", "example": { "type": "percent", "percentage": 10, "duration": 2 }, "type": "object", "properties": { "type": { "type": "string" }, "percentage": { "type": "integer", "format": "int32" }, "duration": { "type": "integer", "format": "int32" } }, "required": [ "type", "percentage", "duration" ] }, "RemoveasubscriptionaddonfromanactivesubscriptionRequest": { "title": "RemoveasubscriptionaddonfromanactivesubscriptionRequest", "example": { "subscriptions": [ { "subscription": "{subscription_id}", "addons": [ { "product": "{subscription_addon_path}", "quantity": 0 } ] } ] }, "type": "object", "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription4" } } }, "required": [ "subscriptions" ] }, "Subscription4": { "title": "Subscription4", "example": { "subscription": "{subscription_id}", "addons": [ { "product": "{subscription_addon_path}", "quantity": 0 } ] }, "type": "object", "properties": { "subscription": { "type": "string" }, "addons": { "type": "array", "items": { "$ref": "#/components/schemas/Addon1" } } }, "required": [ "subscription", "addons" ] }, "Addon1": { "title": "Addon1", "example": { "product": "{subscription_addon_path}", "quantity": 0 }, "type": "object", "properties": { "product": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" } }, "required": [ "product", "quantity" ] }, "ChangeasubscriptionfromautomaticrenewaltomanualRequest": { "title": "ChangeasubscriptionfromautomaticrenewaltomanualRequest", "example": { "subscriptions": [ { "subscription": "{subscription_id}", "manualRenew": "true" } ] }, "type": "object", "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription5" } } }, "required": [ "subscriptions" ] }, "Subscription5": { "title": "Subscription5", "example": { "subscription": "{subscription_id}", "manualRenew": "true" }, "type": "object", "properties": { "subscription": { "type": "string" }, "manualRenew": { "type": "string" } }, "required": [ "subscription", "manualRenew" ] }, "UncancelasubscriptionpriortodeactivationRequest": { "title": "UncancelasubscriptionpriortodeactivationRequest", "example": { "subscriptions": [ { "subscription": "{subscription_id}", "deactivation": null } ] }, "type": "object", "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription6" } } }, "required": [ "subscriptions" ] }, "Subscription6": { "title": "Subscription6", "example": { "subscription": "{subscription_id}", "deactivation": null }, "type": "object", "properties": { "subscription": { "type": "string" }, "deactivation": { "type": "string" } }, "required": [ "subscription", "deactivation" ] }, "RebillmanagedsubscriptioninstanceRequest": { "title": "RebillmanagedsubscriptioninstanceRequest", "example": { "subscriptions": [ { "subscription": "{subscription_id}" } ] }, "type": "object", "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription7" } } }, "required": [ "subscriptions" ] }, "Subscription7": { "title": "Subscription7", "example": { "subscription": "{subscription_id}" }, "type": "object", "properties": { "subscription": { "type": "string" } }, "required": [ "subscription" ] }, "Changethedate_quantityorcouponforanactivesubscriptionRequest": { "title": "Changethedate,quantityorcouponforanactivesubscriptionRequest", "example": { "subscriptions": [ { "subscription": "{subscription_id}", "next": "2019-01-30", "end": 0, "quantity": 2, "coupons": [ "{coupon_id}" ] } ] }, "type": "object", "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription1" } } }, "required": [ "subscriptions" ] }, "Entitlement": { "type": "object", "properties": { "company": { "type": "string" }, "userId": { "type": "string" }, "siteIds": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } }, "storeEntitlements": { "type": "array", "items": { "$ref": "#/components/schemas/StoreEntitlement" } } } }, "StoreEntitlement": { "type": "object", "properties": { "siteId": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "UserPrincipal": { "type": "object", "properties": { "email": { "type": "string" }, "siteId": { "type": "string" }, "siteIds": { "type": "array", "items": { "type": "string" } }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "companyName": { "type": "string" }, "siteName": { "type": "string" }, "loginToken": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "apiAccess": { "type": "boolean" }, "userId": { "type": "string" }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/Entitlement" } }, "clientCredentials": { "type": "boolean" }, "authProviderType": { "type": "string", "enum": [ "COGNITO", "COMMERCE", "SOCIAL_GOOGLE" ] }, "accessToken": { "type": "string" }, "tokenExpires": { "type": "integer", "format": "int64" } } }, "AddressResponse": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "region": { "type": "string" } } }, "ContactResponse": { "type": "object", "properties": { "company": { "type": "string" }, "email": { "type": "string" }, "first": { "type": "string" }, "last": { "type": "string" }, "phone": { "type": "string" }, "userId": { "type": "string" } } }, "ItemRenewalResponse": { "type": "object", "properties": { "renewIntoProductId": { "type": "string", "example": "DG4UH337PVYDC33XEP3ZH3JHD" }, "renewIntoPath": { "type": "string", "example": "video-subscription" }, "renewIntoPrice": { "type": "number", "example": 9.99 }, "renewIntoPeriod": { "type": "string", "example": "Weekly" }, "renewIntoLevel": { "type": "integer", "format": "int32", "example": 1 }, "renewIntoIntervalCount": { "type": "string", "example": "2" }, "renewIntoUpcomingProduct": { "type": "string", "example": "audio-subscription" } } }, "ItemResponse": { "type": "object", "properties": { "product": { "type": "string" }, "customPrice": { "type": "boolean" }, "display": { "type": "string", "example": "Book The Ring" }, "image": { "type": "string", "example": "icon.png" }, "intervalCount": { "type": "string", "example": "2" }, "period": { "type": "string", "example": "Monthly" }, "periodDays": { "type": "string", "example": "0" }, "quantity": { "type": "integer", "format": "int32", "example": 1 }, "renewIntoProducts": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ItemRenewalResponse" } }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTaxResponse" } }, "trialDays": { "type": "integer", "format": "int32", "example": 30 }, "subscription": { "type": "boolean" }, "type": { "type": "string" }, "unitCouponDiscount": { "type": "number" }, "unitCouponDiscountDisplay": { "type": "string" }, "unitCouponDiscountInPayoutCurrency": { "type": "number" }, "unitCouponDiscountInPayoutCurrencyDisplay": { "type": "string" }, "unitDiscount": { "type": "number" }, "unitDiscountDisplay": { "type": "string" }, "unitDiscountInPayoutCurrency": { "type": "number" }, "unitDiscountInPayoutCurrencyDisplay": { "type": "string" }, "unitListPrice": { "type": "number" }, "unitListPriceDisplay": { "type": "string" }, "unitListPriceInPayoutCurrency": { "type": "number" }, "unitListPriceInPayoutCurrencyDisplay": { "type": "string" }, "unitPrice": { "type": "number" }, "unitPriceDisplay": { "type": "string" }, "unitPriceInPayoutCurrency": { "type": "number" }, "unitPriceInPayoutCurrencyDisplay": { "type": "string" }, "unitPriceWithoutTax": { "type": "number" }, "unitPriceWithoutTaxDisplay": { "type": "string" }, "unitListPriceWithoutTax": { "type": "number" }, "unitListPriceWithoutTaxDisplay": { "type": "string" } } }, "ItemTaxResponse": { "type": "object", "properties": { "taxValue": { "type": "number", "example": 0 }, "totalTaxable": { "type": "number", "example": 0 } } }, "Link": { "type": "object", "properties": { "rel": { "type": "string" }, "href": { "type": "string" }, "hreflang": { "type": "string" }, "media": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "deprecation": { "type": "string" }, "profile": { "type": "string" }, "name": { "type": "string" } } }, "QuoteResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The quote id", "example": "QUVJIVYZTQDFBOBEO7IGNXER3VBQ" }, "buyerGenerated": { "type": "boolean" }, "coupon": { "type": "string", "example": "TENOFF" }, "created": { "type": "string", "format": "date-time", "example": "2021-03-02T19:48:56.395Z" }, "createdBy": { "$ref": "#/components/schemas/ContactResponse" }, "currency": { "type": "string", "example": "USD" }, "discount": { "type": "number" }, "discountDisplay": { "type": "string" }, "discountInPayoutCurrency": { "type": "number" }, "discountInPayoutCurrencyDisplay": { "type": "string" }, "expires": { "type": "string", "format": "date-time", "example": "2021-04-01T19:48:56.395Z" }, "expirationDateDays": { "type": "integer", "format": "int32", "example": 30 }, "fulfillmentTerm": { "type": "string", "example": "ON_QUOTE_ACCEPTANCE", "enum": [ "ON_PAYMENT", "ON_QUOTE_ACCEPTANCE" ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemResponse" } }, "name": { "type": "string", "example": "Quote for ABC Company" }, "notes": { "type": "string", "example": "This is a Note" }, "netTermsDays": { "type": "integer", "format": "int32", "example": 30 }, "quoteUrl": { "type": "string", "example": "https://josemunoz.test.qa2.onfastspring.com/popup-defaultB2B/account/order/quote/QUVJIVYZTQDFBOBEO7IGNXER3VBQ" }, "recipient": { "$ref": "#/components/schemas/ContactResponse" }, "recipientAddress": { "$ref": "#/components/schemas/AddressResponse" }, "siteId": { "type": "string", "example": "pOBehkkfTGo" }, "status": { "type": "string", "example": "OPEN", "enum": [ "OPEN", "CANCELED", "AWAITING_PAYMENT", "COMPLETED", "EXPIRED" ] }, "statusHistory": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/StatusHistoryResponse" } }, "subtotal": { "type": "number" }, "subtotalDisplay": { "type": "string" }, "subtotalInPayoutCurrency": { "type": "number" }, "subtotalInPayoutCurrencyDisplay": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagResponse" } }, "tax": { "type": "number" }, "taxType": { "type": "string" }, "total": { "type": "number" }, "totalDisplay": { "type": "string" }, "totalInPayoutCurrency": { "type": "number" }, "totalInPayoutCurrencyDisplay": { "type": "string" }, "updated": { "type": "string", "format": "date-time", "example": "2021-03-02T19:48:56.395Z" }, "taxId": { "type": "string", "example": "BE09999999XX" }, "source": { "type": "string", "example": "MANAGER" }, "sourceIP": { "type": "string", "example": "181.55.25.101" }, "isGrossTax": { "type": "boolean", "example": false }, "invoiceId": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } }, "StatusHistoryResponse": { "type": "object", "properties": { "statusUpdatedTo": { "type": "string", "example": "OPEN", "enum": [ "OPEN", "CANCELED", "AWAITING_PAYMENT", "COMPLETED", "EXPIRED" ] }, "statusUpdatedByFullName": { "type": "string", "example": "John Smith" }, "statusUpdatedByEmail": { "type": "string", "example": "user@yourcompany.com" }, "statusUpdatedOn": { "type": "string", "format": "date-time", "example": "2021-03-02T19:48:56.395Z" } } }, "TagResponse": { "type": "object", "properties": { "key": { "maxLength": 255, "minLength": 0, "type": "string", "example": "tag-key" }, "value": { "maxLength": 255, "minLength": 0, "type": "string", "example": "Tag Value" } } }, "AddressRequest": { "type": "object", "properties": { "addressLine1": { "maxLength": 255, "minLength": 0, "type": "string", "example": "801 Garden St" }, "addressLine2": { "maxLength": 255, "minLength": 0, "type": "string", "example": "Suite 201" }, "city": { "maxLength": 255, "minLength": 0, "type": "string", "example": "Santa Barbara" }, "country": { "maxLength": 2, "minLength": 2, "type": "string", "example": "US" }, "postalCode": { "maxLength": 255, "minLength": 0, "type": "string", "example": "93101" }, "region": { "maxLength": 255, "minLength": 0, "type": "string", "example": "California" } } }, "ContactRequest": { "required": [ "email", "first", "last" ], "type": "object", "properties": { "company": { "maxLength": 255, "minLength": 0, "type": "string", "example": "ABC Company" }, "email": { "maxLength": 255, "minLength": 0, "type": "string", "example": "ne1@all.com" }, "first": { "maxLength": 255, "minLength": 0, "type": "string", "example": "Leeroy" }, "last": { "maxLength": 255, "minLength": 0, "type": "string", "example": "Jenkins" }, "phone": { "maxLength": 255, "minLength": 0, "type": "string", "example": "+1254789654" } } }, "CreateQuoteRequest": { "required": [ "items", "name", "recipient", "recipientAddress" ], "type": "object", "properties": { "coupon": { "maxLength": 255, "minLength": 0, "type": "string", "example": "TENOFF" }, "currency": { "maxLength": 3, "minLength": 3, "type": "string", "example": "USD" }, "expirationDateDays": { "maximum": 90, "minimum": 1, "type": "integer", "format": "int32", "example": 30 }, "fulfillmentTerm": { "type": "string" }, "items": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/ItemRequest" } }, "name": { "type": "string", "example": "Quote for ABC Company" }, "notes": { "maxLength": 5000, "minLength": 0, "type": "string", "example": "This is a Note" }, "netTermsDays": { "type": "integer", "format": "int32" }, "recipientAddress": { "$ref": "#/components/schemas/AddressRequest" }, "recipient": { "$ref": "#/components/schemas/ContactRequest" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagRequest" } }, "taxId": { "maxLength": 255, "minLength": 0, "type": "string", "example": "BE09999999XX" }, "source": { "maxLength": 255, "minLength": 0, "type": "string", "example": "MANAGER" }, "sourceIP": { "maxLength": 25, "minLength": 0, "type": "string", "example": "181.55.25.101" } } }, "ItemRequest": { "required": [ "product" ], "type": "object", "properties": { "product": { "maxLength": 255, "minLength": 0, "type": "string" }, "unitListPrice": { "minimum": 0, "exclusiveMinimum": false, "type": "number" }, "quantity": { "minimum": 1, "type": "integer", "format": "int32" } } }, "TagRequest": { "type": "object", "properties": { "key": { "maxLength": 255, "minLength": 0, "type": "string", "example": "tag-key" }, "value": { "maxLength": 255, "minLength": 0, "type": "string", "example": "Tag Value" } } }, "Pageable": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int64" }, "paged": { "type": "boolean" }, "unpaged": { "type": "boolean" }, "sort": { "$ref": "#/components/schemas/Sort" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" } } }, "Sort": { "type": "object", "properties": { "unsorted": { "type": "boolean" }, "sorted": { "type": "boolean" }, "empty": { "type": "boolean" } } }, "CollectionModelQuoteResponse": { "type": "object", "properties": { "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteResponse" } } } }, "UpdateQuoteRequest": { "required": [ "currency", "expirationDateDays", "fulfillmentTerm", "items", "name", "recipient", "recipientAddress" ], "type": "object", "properties": { "coupon": { "maxLength": 255, "minLength": 0, "type": "string", "example": "TENOFF" }, "currency": { "maxLength": 3, "minLength": 3, "type": "string", "example": "USD" }, "expirationDateDays": { "maximum": 90, "minimum": 1, "type": "integer", "format": "int32", "example": 30 }, "fulfillmentTerm": { "type": "string" }, "items": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/ItemRequest" } }, "name": { "type": "string", "example": "Quote for ABC Company" }, "notes": { "maxLength": 5000, "minLength": 0, "type": "string", "example": "This is a Note" }, "netTermsDays": { "type": "integer", "format": "int32" }, "recipientAddress": { "$ref": "#/components/schemas/AddressRequest" }, "recipient": { "$ref": "#/components/schemas/ContactRequest" }, "status": { "type": "string", "example": "OPEN", "enum": [ "OPEN", "CANCELED", "AWAITING_PAYMENT", "COMPLETED", "EXPIRED" ] }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagRequest" } }, "taxId": { "maxLength": 255, "minLength": 0, "type": "string", "example": "BE09999999XX" }, "source": { "maxLength": 255, "minLength": 0, "type": "string", "example": "MANAGER" }, "sourceIP": { "maxLength": 25, "minLength": 0, "type": "string", "example": "181.55.25.101" }, "invoiceId": { "maxLength": 128, "minLength": 0, "type": "string" } } }, "FilterSubscriptionReportRequest": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "example": "YYYY-MM-DD" }, "endDate": { "type": "string", "format": "date", "example": "YYYY-MM-DD" }, "countryISO": { "type": "array", "items": { "type": "string" } }, "productNames": { "type": "array", "items": { "type": "string" } }, "productPaths": { "type": "array", "items": { "type": "string" } }, "syncDate": { "type": "string", "format": "date", "example": "YYYY-MM-DD" } } }, "FilterRevenueReportRequest": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "example": "YYYY-MM-DD" }, "endDate": { "type": "string", "format": "date", "example": "YYYY-MM-DD" }, "countryISO": { "type": "array", "items": { "type": "string" } }, "productNames": { "type": "array", "items": { "type": "string" } }, "productPaths": { "type": "array", "items": { "type": "string" } }, "syncDate": { "type": "string", "format": "date", "example": "YYYY-MM-DD" } } }, "ConvertExpiredTrialWithoutPaymentMethodResponse": { "title": "ConvertExpiredTrialWithoutPaymentMethodResponse", "example": { "id": "1665462758431", "currency": "USD", "expires": 1665549158235, "order": null, "account": "lGySekKpTm6Mrn4J0qH5fg", "subtotal": 14.99, "items": [ { "product": "monthly-magazine", "quantity": 1 } ] } }, "ConvertExpiredTrialWithoutPaymentMethodErrorResponse": { "title": "ConvertExpiredTrialWithoutPaymentMethodErrorResponse", "example": { "action": "subscription.convert", "result": "error", "error": { "subscription.convert": "Unable to find subscription." } } }, "EstimateSubscriptionRequest": { "title": "EstimateSubscriptionRequest", "required": [ "subscription" ], "type": "object", "properties": { "subscription": { "type": "string" }, "product": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "pricing": { "$ref": "#/components/schemas/SubscriptionPricing" }, "addons": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAddon" } } } }, "SubscriptionPricing": { "title": "Pricing", "type": "object", "$ref": "#/components/schemas/Price" }, "SubscriptionAddon": { "title": "AddOn", "type": "object", "properties": { "product": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "pricing": { "$ref": "#/components/schemas/SubscriptionPricing" } } }, "EstimateSubscriptionSuccessResponse": { "title": "EstimateSubscriptionSuccessResponse", "example": { "subscription": "mG7NGFRMQXSz0ud-Ybp7gA", "currency": "USD", "timezone": "UTC", "periodStartDate": 1679961600000, "periodStartDateDisplay": "3/28/23", "periodStartDateDisplayISO8601": "2023-03-28", "periodEndDate": 1682553600000, "periodEndDateDisplay": "4/27/23", "periodEndDateDisplayISO8601": "2023-04-27", "currentPlan": { "display": "Basic", "product": "basic", "billingFrequency": "1 month", "price": 200, "priceDisplay": "$200.00", "discount": 0, "discountDisplay": "$0.00", "quantity": 1, "subtotal": 200, "subtotalDisplay": "$200.00", "tax": 0, "taxDisplay": "$0.00", "total": 200, "totalDisplay": "$200.00", "taxPercent": 7.75, "taxPercentDisplay": "7.75%", "periodStartDate": 1679961600000, "periodStartDateDisplay": "3/28/23", "periodStartDateDisplayISO8601": "2023-03-28", "periodEndDate": 1679961600000, "periodEndDateDisplay": "3/28/23", "periodEndDateDisplayISO8601": "2023-03-28", "proratedItemCharge": 300, "proratedItemChargeDisplay": "$300.00", "proratedItemCredit": 200, "proratedItemCreditDisplay": "$200.00", "proratedItemSubtotalDisplay": "$100.00", "proratedItemTax": 0, "proratedItemTaxDisplay": "$0.00", "proratedItemTotal": 100, "proratedItemTotalDisplay": "$100.00", "addons": [], "subscriptionSubtotal": 200, "subscriptionSubtotalDisplay": "$200.00", "subscriptionTax": 0, "subscriptionTaxDisplay": "$0.00", "subscriptionTotal": 200, "subscriptionTotalDisplay": "$200.00", "subscriptionProratedCredit": 200, "subscriptionProratedCreditDisplay": "$200.00" }, "proposedPlan": { "display": "Premium", "product": "premium", "billingFrequency": "1 month", "price": 300, "priceDisplay": "$300.00", "discount": 0, "discountDisplay": "$0.00", "quantity": 1, "subtotal": 300, "subtotalDisplay": "$300.00", "tax": 0, "taxDisplay": "$0.00", "total": 300, "totalDisplay": "$300.00", "taxPercent": 7.75, "taxPercentDisplay": "7.75%", "periodStartDate": 1679961600000, "periodStartDateDisplay": "3/28/23", "periodStartDateDisplayISO8601": "2023-03-28", "periodEndDate": 1682553600000, "periodEndDateDisplay": "4/27/23", "periodEndDateDisplayISO8601": "2023-04-27", "proratedItemCharge": 300, "proratedItemChargeDisplay": "$300.00", "proratedItemCredit": 200, "proratedItemCreditDisplay": "$200.00", "proratedItemSubtotal": 100, "proratedItemSubtotalDisplay": "$100.00", "proratedItemTax": 0, "proratedItemTaxDisplay": "$0.00", "proratedItemTotal": 100, "proratedItemTotalDisplay": "$100.00", "addons": [], "subscriptionSubtotal": 300, "subscriptionSubtotalDisplay": "$300.00", "subscriptionTax": 0, "subscriptionTaxDisplay": "$0.00", "subscriptionTotal": 300, "subscriptionTotalDisplay": "$300.00", "subscriptionProratedCharge": 300, "subscriptionProratedChargeDisplay": "$300.00" }, "amountDue": { "prorationSubtotal": 100, "prorationSubtotalDisplay": "$100.00", "prorationTax": 0, "prorationTaxDisplay": "$0.00", "totalAmountDue": 100, "totalAmountDueDisplay": "$100.00", "nextChargeDate": 1682640000000, "nextChargeDateDisplay": "4/28/23", "nextChargeDateDisplayISO8601": "2023-04-28", "nextChargeAmount": 300, "nextChargeAmountDisplay": "$300.00" } } }, "EstimateSubscriptionErrorResponse": { "title": "EstimateSubscriptionErrorResponse", "example": { "action": "subscriptions.estimate.update", "subscription": "VtKCOlk-SzSM_Zw2H5ntWw", "result": "error", "error": { "subscription": "Subscription is not changeable." } } }, "GetAllOffersforProductByOfferTypeSuccessResponse": { "title": "GetAllOffersforProductByOfferTypeSuccessResponse", "example": { "products": [ { "action": "product.offers.get", "result": "success", "product": "basic", "offers": [ { "type": "addon", "display": { "en": "Add-Ons" }, "items": [ "analytics-dashboard", "email-integration", "marketing-automation" ] }, { "type": "cross-sell", "display": { "en": "💡 Discover our complementary products to maximize your results." }, "items": [ "support-module", "social-media-monitoring" ] }, { "type": "upsell", "display": { "en": "🚀 Take your experience to the next level with our premium plans." }, "items": [ "standard", "pro", "enterprise" ] }, { "type": "downsell", "display": { "en": "💰 Save big with our budget-friendly option." }, "items": [ "starter" ] }, { "type": "downgrade", "display": { "en": "✅ Keep your subscription within budget without sacrificing quality." }, "items": [ "starter" ] }, { "type": "crossgrade", "display": { "en": "💡 Unlock new possibilities by including any of these items." }, "items": [ "support-module", "social-media-monitoring" ] }, { "type": "upgrade", "display": { "en": "🚀 Supercharge your subscription with premium plans." }, "items": [ "standard", "pro", "enterprise" ] } ] } ] } }, "CreateorupdateProductOffersRequest": { "title": "CreateorupdateProductOffersRequest", "example": { "products": { "product": "basic", "offers": [ { "type": "upgrade", "display": { "en": "🚀 Supercharge your subscription with premium plans." }, "items": [ "standard", "pro", "enterprise" ] } ] } } }, "CreateProductOffersResponse": { "title": "CreateProductOffersResponse", "example": { "products": { "product": "basic", "action": "product.offers.create", "result": "success" } } }, "UpdateProductOffersResponse": { "title": "UpdateProductOffersResponse", "example": { "products": { "product": "basic", "action": "product.offers.update", "result": "success" } } }, "CreateorupdateProductOffersError": { "title": "CreateorupdateProductOffersError", "example": { "product": "basicc", "action": "products.offers.update", "result": "error", "error": { "product": "Product in URL 'basicc' does not match product in request body 'basic'" } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true }, "_id": "60c1d1c3b07d1c001e60b0f9" }