Use this method to trigger a payment of a product, defined by the product id. You need also pass the payment provider config you want to use (need to be valid for the contract of the product).

Depending on this you may need to send data as key values the payment provider needs. If they are not available, the API is rejecting your requet.

For the provider config for Stripe this is:

• stripeCustomerId or customerId: customer id in stripe, you get this information for your user on the user profile call GET /v5/user/profile
• paymentMethodId: you need to select this one via Stripe directly in your Frontend

Use this method to trigger an initiation of trial period of a product, defined by the product id. You need also pass Stripe as a payment provider (need to be valid for the contract of the product).

For the provider config for Stripe this is:

• stripeCustomerId or customerId: customer id in stripe, you get this information for your user on the user profile call GET /v5/user/profile
• paymentMethodId: you need to select this one via Stripe directly in your Frontend

Use this method if you want to place an order for products into a certain contract. This can only be done by agency users, if you want to purchase a product as a self service user, please user the purchase endpoint.

You can directly pass the location ids you want to link. When you directly pass them you can also define the start date.

In case additional data is needed for the product (e.g. sea budget,tageting etc.) you need to pass it through the corresponding api calls afterwards.

The created subscription is waiting until all required data fields are set before any action is taken. The response and the get products endpoint indicates where additional data is required.

Use this call to calculate the costs you would need to pay to purchase a product. Check with this call how high the proration costs would be if you want to put the purchase product into the invoice interval cycle.

Send the same body you would send to the endpoint: /v5/contract/{contractId}/purchase

This method allows you to set subscription related data.

Next to free text fields as external id and a note you can also set the end date. It must be greater than or equal to today.

end date = null means, the subscription runs unlimited until end date gets defined. if you want to cancel a running subscription, set the end_date to today (or the next possible date)

The start date can only be changed if it hasn't been reached yet. It must be greater than or equal to today.

Use the endpoint to send specific actions to a subscripton. Which actions are available for the subscription of a certain product you see via the endpoints:

• /v5/contract/{contractId}/subscription
• /v5/contract/{contractId}/defined-products with the workspace contract id
• /v5/contract/{contractId}/product with the company contract id

Fetch all the subscription that do belong to a (company) contract.

cancel this product from the contract

this call shall only be called by a self service user

Get all available products for your contract.

The response contains also all created and available connections to locations, their statuses and all available actions you may execute.

Right now this call shall only be used for self service company contracts.

Get the price list data for your contract.

Get all products that are defined theoretically for all customers of a workspace.

Note: There could be restrictions that does not allow a company to order one of those products (e.g. country restriction). To get a more reliable list for a certain company, you may want to user the following endpoint: /v5/contract/{contractId}/product

Check if location(s) can book a Free trial for the specified product.

get the list of all contracts the logged in user is allowed to see. Only the first level of contracts is returned. Use the query parameter to restrict the search, if you do so, you need to define contextType and contextId, both.

save new payment method id in stripe for now only Note: later will be used for all the payment providers

get the list of all contracts the logged in user is allowed to see. Only the workspace level of contracts is returned. Use the query parameter to restrict the search, if you do so, you need to define contextType and contextId, both.

Get the history of all Billing History of this contract Path Params: id: company contractId

//TODO Marjol put documentation of path parameter to description of path parameter ... //TODO Marjol rename the path to /v5/contract/{contractId}/invoices

get the biling invoice of your Contract invoice

In case a payment provider is not yet initiated for your user, you can do it here. You need to have payment provider configured to pay products in any self service contract. The payment provider being available and configured you can see in your user profile GET /user/profile

returns the profile of the logged in user

A delete method to remove a company and all of it's locations, if there are no active paid producs.

Note: an exception are the free products that will be automatically terminated by deleting the company

Method to create a location by defining all mandatory fields. If you want to insert some additional, media or social media fields, use the corresponding update methods afterwards.

If a self service user wants to create a new location for her/his company, pinVerification and claimId need to be set. Those need to be triggerd by the /company/claim endpoint via the location main phone number.

method to delete Locations

Note: In order to delete location's all paid products must be terminated , an exception are the free products that will be automatically terminated by deleting the location's

add main phone to location Path Params: id: id of the location

This function provides a list of aggregated statistics for different products. The statistics are aggregated based on the chosen time interval. If available, you will also see the periodic changes compared to the statistics of the previous period, which is determined by the same number of days you defined with "from" and "to."

If the statistics are displayed for a single product line (e.g., listing), you will see the extended KPIs listed as an additional detailed layer. Otherwise (e.g., listing and sea), you will see the product lines in this layer.

To check which KPIs are available, feel free to request them through the 'possible KPIs' call.

To access the statistics, you need to order a product that includes the 'Analytics' functionality for your locations. Locations without an active subscription for this feature will not be considered in the response, even if you try to retrieve statistics for the parent company.

This function returns a list of chronological statistics for different products. The statistics are aggregated based on the chosen time interval and aggregation type. You have the option to view statistics on a daily, monthly, or yearly basis.

If the statistics are displayed for a single product line (e.g., listing), you will see the extended KPIs listed as an additional detailed layer. Otherwise (e.g., listing and sea), you will see the product lines in that layer.

To check which KPIs are available, you can request them through the 'possible KPIs' call.

To access the statistics, you need to order a product that includes the 'Analytics' functionality for your locations. Locations without an active subscription for this feature will not be included in the response, even if you try to retrieve statistics for the parent company.

Returns a list of possible kpis. You can filter for products to see what you could get by the statistics calls.

Remark: To get the detailed extended kpis for a products you need to set the filter correspondingly in the statistic aggregated or chronology call.

This function returns a list made phone calls to a call tracking number. You can get the list either for single call tracking subscriptions or on company/location level for all call tracking subscriptions underneath.

To access the statistics, you need to order a product that includes the 'Analytics' functionality for your locations. Locations without an active subscription for this feature will not be included in the response, even if you try to retrieve statistics for the parent company.