REST RPC APIProducts

Free Trial Create

View as Markdown
Creates a new free trial configuration for a product This endpoint accepts the Application API Scope only. Storefront API Scope signatures are rejected.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

Path parameters

product_idstringRequired
Merchant product ID

Request

This endpoint expects an object.
duration_in_daysintegerRequired
Number of days the free trial will last

Response

201
public_idstring
Free trial configuration public id
duration_in_daysinteger
Number of days the free trial will last
createdstring
last_updatedstring

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error