Pricing

Define your pricing model and manage your customers' subscriptions.

Introduction

Pricing is a way to define the pricing for your products. It is a set of rules that define the price of a product based on the customer's level.

Properties

Name
id
Type
string
Description
Unique identifier for the conversation.
Name
organizationId
Type
string
Description
Unique identifier for the organization.
Name
productGroupId
Type
string
Description
Unique identifier for the Product
Name
pricingName
Type
string
Description
Name of the pricing scheme
Name
startDate
Type
string
Description
The date and time the Pricing is active from.
Name
endDate
Type
string
Description
The date and time the Pricing is active to.
Name
createdAt
Type
datetime
Description
The date and time the Pricing was created.
Name
updatedAt
Type
datetime
Description
The date and time the Pricing was last updated.

POST/pricing/create

Create Pricing

Create Pricing of Leveled Billing and subscriptions

Required attributes

Name
organizationId
Type
string
Description
Unique identifier for the organization.
Name
productGroupId
Type
string
Description
Unique identifier for the Product
Name
pricingName
Type
string
Description
Name for the pricing scheme (Example: 2022 Pricing, 2023 Pricing, etc.)

Request

POST

/pricing/create

curl --location --request POST 'https://api.bluehillpayments.io/pricing/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "organizationId": "{{organizationId}}",
    "productGroupId": "B83C0927071349F780FEA02E09F7E167", 
    "pricingName": "2023 Pricing"
}'

Response

  {
    "status": "success"
  }

POST/pricing/duplicate

Duplicate Pricing

Create Pricing of Leveled Billing and subscriptions

Required attributes

Name
organizationId
Type
string
Description
Unique identifier for the organization.
Name
productGroupId
Type
string
Description
Unique identifier for the Product
Name
pricingId
Type
string
Description
Unique identifier for the existing Pricing to duplicate
Name
pricingName
Type
string
Description
Name for the pricing scheme (Example: 2022 Pricing, 2023 Pricing, etc.)

Request

POST

/pricing/create

curl --location --request POST 'https://api.bluehillpayments.io/pricing/duplicate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "organizationId": "{{organizationId}}",
    "productGroupId": "B83C0927071349F780FEA02E09F7E167", 
    "pricingName": "2023 Pricing",
    "pricingId": "17F0AFFBD7B746088427467E58A10496"
}'

Response

  {
    "status": "success"
  }

GET/pricing/get/:pricingId

Get Pricing

This endpoint allows you to retrieve a transaction by its unique identifier.

Request

GET

/pricing/get/:pricingId

curl --location --request GET 'https://api.bluehillpayments.io/pricing/get/1487BE9B5975432699B91379C7A6539B' \
--data-raw ''

Response

{
    "data": {
        "createdAt": "2023-01-16 19:09:38",
        "endDate": null,
        "id": "1487BE9B5975432699B91379C7A6539B",
        "organizationId": "{{organizationId}}",
        "pricingName": "2023 Pricing",
        "productGroupId": "D929195A875044179E26026353C531C1",
        "startDate": null,
        "updatedAt": "2023-01-16 19:09:38"
    },
    "success": true
}

GET/pricing/get-all/:organizationId

Get All Pricing

This endpoint allows you to retrieve all pricing for an organization.

Request

GET

/pricing/get-all/:organizationId

  curl --location --request GET 'https://api.bluehillpayments.io/pricing/get-all/{{organizationId}}' \
  --data-raw ''

Response

{
  "data": [
      {
          "createdAt": "2023-01-16 04:12:33",
          "endDate": null,
          "id": "01726A040B2543BDADC513C826766C85",
          "organizationId": "{{organizationId}}",
          "pricingName": "2022 Pricing",
          "productGroupId": "BDEACDAA6AE5415B810479DEF0BF336F",
          "startDate": null,
          "updatedAt": "2023-01-16 04:12:33"
      },
      {
          "createdAt": "2023-01-16 04:12:33",
          "endDate": null,
          "id": "0D9CA55315B34D90A384F0D22B765B55",
          "organizationId": "{{organizationId}}",
          "pricingName": "2022 Pricing",
          "productGroupId": "0C32EE233E3E431487C36D6ACFA1FDC3",
          "startDate": null,
          "updatedAt": "2023-01-16 04:12:33"
      }
      ...
  ],
  "success": true
}