Create a new product

post

https://Contact sales to enable your sandbox/products

At its core, Canopy allows you to create credit products that meet the specific needs of your users. We offer robust options to configure these products within our system.

For most use cases, we recommend configuring products by sending an excel file detailing your preferred configurations to the Canopy team; however, you can also configure and manage products programmatically using this API documentation.

Request body for creating a new product.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

effective_at

date-time

Defaults to 1900-01-01T12:00:00+00:00

The Date-Time as of which this product is effective on the server. Your product should be older than all accounts enrolled in it.

product_id

string

A unique ID to identify the product with for future requests. If not provided at the time of product creation, Canopy will generate one.

product_overview

object

required

A series of static fields about the product.

product_lifecycle_policies

object

required

promotional_policies

object

required

If applicable, a promotional configuration for the product.

post_promotional_policies

object

interest_management_policies

object

admin

object

metro2_config

object

Metro2 credit reporting configs

Responses

401

Unauthorized.

403

Forbidden.

409

Conflict.

422

Invalid input

429

Too many requests.

default

Unexpected Error.

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Product