Product Price Points

productPricePointsController := client.ProductPricePointsController()

Class Name

ProductPricePointsController

Methods

Create Product Price Point
List Product Price Points
Update Product Price Point
Read Product Price Point
Archive Product Price Point
Unarchive Product Price Point
Promote Product Price Point to Default
Bulk Create Product Price Points
Create Product Currency Prices
Update Product Currency Prices
List All Product Price Points

Create Product Price Point

Product Price Point Documentation

CreateProductPricePoint(
    ctx context.Context,
    productId models.CreateProductPricePointProductId,
    body *models.CreateProductPricePointRequest) (
    models.ApiResponse[models.ProductPricePointResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`productId`	`models.CreateProductPricePointProductId`	Template, Required	This is a container for one-of cases.
`body`	`*models.CreateProductPricePointRequest`	Body, Optional	-

Response Type

models.ProductPricePointResponse

Example Usage

ctx := context.Background()

productId := models.CreateProductPricePointProductIdContainer.FromNumber(124)

body := models.CreateProductPricePointRequest{
    PricePoint: models.CreateProductPricePoint{
        Name:                    "Educational",
        Handle:                  models.ToPointer("educational"),
        PriceInCents:            int64(1000),
        Interval:                1,
        IntervalUnit:            models.IntervalUnit("month"),
        TrialPriceInCents:       models.ToPointer(int64(4900)),
        TrialInterval:           models.ToPointer(1),
        TrialIntervalUnit:       models.ToPointer(models.IntervalUnit("month")),
        TrialType:               models.ToPointer("payment_expected"),
        InitialChargeInCents:    models.ToPointer(int64(120000)),
        InitialChargeAfterTrial: models.ToPointer(false),
        ExpirationInterval:      models.ToPointer(12),
        ExpirationIntervalUnit:  models.ToPointer(models.IntervalUnit("month")),
    },
}

apiResponse, err := productPricePointsController.CreateProductPricePoint(ctx, productId, &body)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "price_point": {
    "id": 283,
    "name": "Educational",
    "handle": "educational",
    "price_in_cents": 1000,
    "interval": 1,
    "interval_unit": "month",
    "trial_price_in_cents": 4900,
    "trial_interval": 1,
    "trial_interval_unit": "month",
    "trial_type": "payment_expected",
    "initial_charge_in_cents": 120000,
    "initial_charge_after_trial": false,
    "expiration_interval": 12,
    "expiration_interval_unit": "month",
    "product_id": 901,
    "archived_at": "2023-11-30T06:37:20-05:00",
    "created_at": "2023-11-27T06:37:20-05:00",
    "updated_at": "2023-11-27T06:37:20-05:00"
  }
}

Errors

HTTP Status Code	Error Description	Exception Class
422	Unprocessable Entity (WebDAV)	`ProductPricePointErrorResponseException`

List Product Price Points

Use this endpoint to retrieve a list of product price points.

ListProductPricePoints(
    ctx context.Context,
    input ListProductPricePointsInput) (
    models.ApiResponse[models.ListProductPricePointsResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`productId`	`models.ListProductPricePointsInputProductId`	Template, Required	This is a container for one-of cases.
`page`	`*int`	Query, Optional	Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query `page=1`.
`perPage`	`*int`	Query, Optional	This parameter indicates how many records to fetch in each request. Default value is 10. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
`currencyPrices`	`*bool`	Query, Optional	When fetching a product's price points, if you have defined multiple currencies at the site level, you can optionally pass the ?currency_prices=true query param to include an array of currency price data in the response. If the product price point is set to use_site_exchange_rate: true, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency.
`filterType`	`[]models.PricePointType`	Query, Optional	Use in query: `filter[type]=catalog,default`.

Response Type

models.ListProductPricePointsResponse

Example Usage

ctx := context.Background()

collectedInput := advancedbilling.ListProductPricePointsInput{
    ProductId:      models.ListProductPricePointsInputProductIdContainer.FromNumber(124),
    Page:           models.ToPointer(2),
    PerPage:        models.ToPointer(10),
Liquid error: Value cannot be null. (Parameter 'key')}

apiResponse, err := productPricePointsController.ListProductPricePoints(ctx, collectedInput)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "price_points": [
    {
      "id": 283,
      "name": "Educational",
      "handle": "educational",
      "price_in_cents": 1000,
      "interval": 1,
      "interval_unit": "month",
      "trial_price_in_cents": 4900,
      "trial_interval": 1,
      "trial_interval_unit": "month",
      "trial_type": "payment_expected",
      "initial_charge_in_cents": 120000,
      "initial_charge_after_trial": false,
      "expiration_interval": 12,
      "expiration_interval_unit": "month",
      "product_id": 901,
      "archived_at": "2023-11-30T06:37:20-05:00",
      "created_at": "2023-11-27T06:37:20-05:00",
      "updated_at": "2023-11-27T06:37:20-05:00"
    }
  ]
}

Update Product Price Point

Use this endpoint to update a product price point.

Note: Custom product price points are not able to be updated.

UpdateProductPricePoint(
    ctx context.Context,
    productId models.UpdateProductPricePointProductId,
    pricePointId models.UpdateProductPricePointPricePointId,
    body *models.UpdateProductPricePointRequest) (
    models.ApiResponse[models.ProductPricePointResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`productId`	`models.UpdateProductPricePointProductId`	Template, Required	This is a container for one-of cases.
`pricePointId`	`models.UpdateProductPricePointPricePointId`	Template, Required	This is a container for one-of cases.
`body`	`*models.UpdateProductPricePointRequest`	Body, Optional	-

Response Type

models.ProductPricePointResponse

Example Usage

ctx := context.Background()

productId := models.UpdateProductPricePointProductIdContainer.FromNumber(124)

pricePointId := models.UpdateProductPricePointPricePointIdContainer.FromNumber(188)

body := models.UpdateProductPricePointRequest{
    PricePoint: models.UpdateProductPricePoint{
        Handle:       models.ToPointer("educational"),
        PriceInCents: models.ToPointer(int64(1250)),
    },
}

apiResponse, err := productPricePointsController.UpdateProductPricePoint(ctx, productId, pricePointId, &body)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "price_point": {
    "id": 283,
    "name": "Educational",
    "handle": "educational",
    "price_in_cents": 1000,
    "interval": 1,
    "interval_unit": "month",
    "trial_price_in_cents": 4900,
    "trial_interval": 1,
    "trial_interval_unit": "month",
    "trial_type": "payment_expected",
    "initial_charge_in_cents": 120000,
    "initial_charge_after_trial": false,
    "expiration_interval": 12,
    "expiration_interval_unit": "month",
    "product_id": 901,
    "archived_at": "2023-11-30T06:37:20-05:00",
    "created_at": "2023-11-27T06:37:20-05:00",
    "updated_at": "2023-11-27T06:37:20-05:00"
  }
}

Read Product Price Point

Use this endpoint to retrieve details for a specific product price point.

ReadProductPricePoint(
    ctx context.Context,
    productId models.ReadProductPricePointProductId,
    pricePointId models.ReadProductPricePointPricePointId,
    currencyPrices *bool) (
    models.ApiResponse[models.ProductPricePointResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`productId`	`models.ReadProductPricePointProductId`	Template, Required	This is a container for one-of cases.
`pricePointId`	`models.ReadProductPricePointPricePointId`	Template, Required	This is a container for one-of cases.
`currencyPrices`	`*bool`	Query, Optional	When fetching a product's price points, if you have defined multiple currencies at the site level, you can optionally pass the ?currency_prices=true query param to include an array of currency price data in the response. If the product price point is set to use_site_exchange_rate: true, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency.

Response Type

models.ProductPricePointResponse

Example Usage

ctx := context.Background()

productId := models.ReadProductPricePointProductIdContainer.FromNumber(124)

pricePointId := models.ReadProductPricePointPricePointIdContainer.FromNumber(188)



apiResponse, err := productPricePointsController.ReadProductPricePoint(ctx, productId, pricePointId, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "price_point": {
    "id": 283,
    "name": "Educational",
    "handle": "educational",
    "price_in_cents": 1000,
    "interval": 1,
    "interval_unit": "month",
    "trial_price_in_cents": 4900,
    "trial_interval": 1,
    "trial_interval_unit": "month",
    "trial_type": "payment_expected",
    "initial_charge_in_cents": 120000,
    "initial_charge_after_trial": false,
    "expiration_interval": 12,
    "expiration_interval_unit": "month",
    "product_id": 901,
    "archived_at": "2023-11-30T06:37:20-05:00",
    "created_at": "2023-11-27T06:37:20-05:00",
    "updated_at": "2023-11-27T06:37:20-05:00"
  }
}

Archive Product Price Point

Use this endpoint to archive a product price point.

ArchiveProductPricePoint(
    ctx context.Context,
    productId models.ArchiveProductPricePointProductId,
    pricePointId models.ArchiveProductPricePointPricePointId) (
    models.ApiResponse[models.ProductPricePointResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`productId`	`models.ArchiveProductPricePointProductId`	Template, Required	This is a container for one-of cases.
`pricePointId`	`models.ArchiveProductPricePointPricePointId`	Template, Required	This is a container for one-of cases.

Response Type

models.ProductPricePointResponse

Example Usage

ctx := context.Background()

productId := models.ArchiveProductPricePointProductIdContainer.FromNumber(124)

pricePointId := models.ArchiveProductPricePointPricePointIdContainer.FromNumber(188)

apiResponse, err := productPricePointsController.ArchiveProductPricePoint(ctx, productId, pricePointId)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "price_point": {
    "id": 283,
    "name": "Educational",
    "handle": "educational",
    "price_in_cents": 1000,
    "interval": 1,
    "interval_unit": "month",
    "trial_price_in_cents": 4900,
    "trial_interval": 1,
    "trial_interval_unit": "month",
    "trial_type": "payment_expected",
    "initial_charge_in_cents": 120000,
    "initial_charge_after_trial": false,
    "expiration_interval": 12,
    "expiration_interval_unit": "month",
    "product_id": 901,
    "archived_at": "2023-11-30T06:37:20-05:00",
    "created_at": "2023-11-27T06:37:20-05:00",
    "updated_at": "2023-11-27T06:37:20-05:00"
  }
}

Errors

HTTP Status Code	Error Description	Exception Class
422	Unprocessable Entity (WebDAV)	`ErrorListResponseException`

Unarchive Product Price Point

Use this endpoint to unarchive an archived product price point.

UnarchiveProductPricePoint(
    ctx context.Context,
    productId int,
    pricePointId int) (
    models.ApiResponse[models.ProductPricePointResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`productId`	`int`	Template, Required	The Chargify id of the product to which the price point belongs
`pricePointId`	`int`	Template, Required	The Chargify id of the product price point

Response Type

models.ProductPricePointResponse

Example Usage

ctx := context.Background()

productId := 202

pricePointId := 10

apiResponse, err := productPricePointsController.UnarchiveProductPricePoint(ctx, productId, pricePointId)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "price_point": {
    "id": 283,
    "name": "Educational",
    "handle": "educational",
    "price_in_cents": 1000,
    "interval": 1,
    "interval_unit": "month",
    "trial_price_in_cents": 4900,
    "trial_interval": 1,
    "trial_interval_unit": "month",
    "trial_type": "payment_expected",
    "initial_charge_in_cents": 120000,
    "initial_charge_after_trial": false,
    "expiration_interval": 12,
    "expiration_interval_unit": "month",
    "product_id": 901,
    "archived_at": "2023-11-30T06:37:20-05:00",
    "created_at": "2023-11-27T06:37:20-05:00",
    "updated_at": "2023-11-27T06:37:20-05:00"
  }
}

Promote Product Price Point to Default

Use this endpoint to make a product price point the default for the product.

Note: Custom product price points are not able to be set as the default for a product.

PromoteProductPricePointToDefault(
    ctx context.Context,
    productId int,
    pricePointId int) (
    models.ApiResponse[models.ProductResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`productId`	`int`	Template, Required	The Chargify id of the product to which the price point belongs
`pricePointId`	`int`	Template, Required	The Chargify id of the product price point

Response Type

models.ProductResponse

Example Usage

ctx := context.Background()

productId := 202

pricePointId := 10

apiResponse, err := productPricePointsController.PromoteProductPricePointToDefault(ctx, productId, pricePointId)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "product": {
    "id": 29778,
    "name": "Educational",
    "handle": "educational",
    "description": null,
    "accounting_code": null,
    "request_credit_card": true,
    "expiration_interval": 12,
    "expiration_interval_unit": "month",
    "created_at": "2023-12-01T06:56:12-05:00",
    "updated_at": "2023-12-01T06:56:26-05:00",
    "price_in_cents": 100,
    "interval": 2,
    "interval_unit": "month",
    "initial_charge_in_cents": 120000,
    "trial_price_in_cents": 4900,
    "trial_interval": 1,
    "trial_interval_unit": "month",
    "archived_at": null,
    "require_credit_card": true,
    "return_params": null,
    "taxable": false,
    "update_return_url": null,
    "tax_code": null,
    "initial_charge_after_trial": false,
    "version_number": 1,
    "update_return_params": null,
    "default_product_price_point_id": 32395,
    "request_billing_address": false,
    "require_billing_address": false,
    "require_shipping_address": false,
    "use_site_exchange_rate": true,
    "item_category": null,
    "product_price_point_id": 32395,
    "product_price_point_name": "Default",
    "product_price_point_handle": "uuid:8c878f50-726e-013c-c71b-0286551bb34f",
    "product_family": {
      "id": 933860,
      "name": "Acme Projects",
      "description": "Amazing project management tool",
      "handle": "acme-projects",
      "accounting_code": null,
      "created_at": "2023-12-01T06:56:12-05:00",
      "updated_at": "2023-12-01T06:56:12-05:00"
    }
  }
}

Bulk Create Product Price Points

Use this endpoint to create multiple product price points in one request.

BulkCreateProductPricePoints(
    ctx context.Context,
    productId int,
    body *models.BulkCreateProductPricePointsRequest) (
    models.ApiResponse[models.BulkCreateProductPricePointsResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`productId`	`int`	Template, Required	The Chargify id of the product to which the price points belong
`body`	`*models.BulkCreateProductPricePointsRequest`	Body, Optional	-

Response Type

models.BulkCreateProductPricePointsResponse

Example Usage

ctx := context.Background()

productId := 202

body := models.BulkCreateProductPricePointsRequest{
    PricePoints: []models.CreateProductPricePoint{
        models.CreateProductPricePoint{
            Name:                    "Educational",
            Handle:                  models.ToPointer("educational"),
            PriceInCents:            int64(1000),
            Interval:                1,
            IntervalUnit:            models.IntervalUnit("month"),
            TrialPriceInCents:       models.ToPointer(int64(4900)),
            TrialInterval:           models.ToPointer(1),
            TrialIntervalUnit:       models.ToPointer(models.IntervalUnit("month")),
            TrialType:               models.ToPointer("payment_expected"),
            InitialChargeInCents:    models.ToPointer(int64(120000)),
            InitialChargeAfterTrial: models.ToPointer(false),
            ExpirationInterval:      models.ToPointer(12),
            ExpirationIntervalUnit:  models.ToPointer(models.IntervalUnit("month")),
        },
        models.CreateProductPricePoint{
            Name:                    "More Educational",
            Handle:                  models.ToPointer("more-educational"),
            PriceInCents:            int64(2000),
            Interval:                1,
            IntervalUnit:            models.IntervalUnit("month"),
            TrialPriceInCents:       models.ToPointer(int64(4900)),
            TrialInterval:           models.ToPointer(1),
            TrialIntervalUnit:       models.ToPointer(models.IntervalUnit("month")),
            TrialType:               models.ToPointer("payment_expected"),
            InitialChargeInCents:    models.ToPointer(int64(120000)),
            InitialChargeAfterTrial: models.ToPointer(false),
            ExpirationInterval:      models.ToPointer(12),
            ExpirationIntervalUnit:  models.ToPointer(models.IntervalUnit("month")),
        },
    },
}

apiResponse, err := productPricePointsController.BulkCreateProductPricePoints(ctx, productId, &body)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "price_points": [
    {
      "id": 283,
      "name": "Educational",
      "handle": "educational",
      "price_in_cents": 1000,
      "interval": 1,
      "interval_unit": "month",
      "trial_price_in_cents": 4900,
      "trial_interval": 1,
      "trial_interval_unit": "month",
      "trial_type": "payment_expected",
      "initial_charge_in_cents": 120000,
      "initial_charge_after_trial": false,
      "expiration_interval": 12,
      "expiration_interval_unit": "month",
      "product_id": 901,
      "archived_at": "2023-11-30T06:37:20-05:00",
      "created_at": "2023-11-27T06:37:20-05:00",
      "updated_at": "2023-11-27T06:37:20-05:00"
    }
  ]
}

Errors

HTTP Status Code	Error Description	Exception Class
422	Unprocessable Entity (WebDAV)	`ApiError`

Create Product Currency Prices

This endpoint allows you to create currency prices for a given currency that has been defined on the site level in your settings.

When creating currency prices, they need to mirror the structure of your primary pricing. If the product price point defines a trial and/or setup fee, each currency must also define a trial and/or setup fee.

Note: Currency Prices are not able to be created for custom product price points.

CreateProductCurrencyPrices(
    ctx context.Context,
    productPricePointId int,
    body *models.CreateProductCurrencyPricesRequest) (
    models.ApiResponse[models.CurrencyPricesResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`productPricePointId`	`int`	Template, Required	The Chargify id of the product price point
`body`	`*models.CreateProductCurrencyPricesRequest`	Body, Optional	-

Response Type

models.CurrencyPricesResponse

Example Usage

ctx := context.Background()

productPricePointId := 234

body := models.CreateProductCurrencyPricesRequest{
    CurrencyPrices: []models.CreateProductCurrencyPrice{
        models.CreateProductCurrencyPrice{
            Currency: "EUR",
            Price:    60,
            Role:     models.CurrencyPriceRole("baseline"),
        },
        models.CreateProductCurrencyPrice{
            Currency: "EUR",
            Price:    30,
            Role:     models.CurrencyPriceRole("trial"),
        },
        models.CreateProductCurrencyPrice{
            Currency: "EUR",
            Price:    100,
            Role:     models.CurrencyPriceRole("initial"),
        },
    },
}

apiResponse, err := productPricePointsController.CreateProductCurrencyPrices(ctx, productPricePointId, &body)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "currency_prices": [
    {
      "id": 100,
      "currency": "EUR",
      "price": 123,
      "formatted_price": "€123,00",
      "product_price_point_id": 32669,
      "role": "baseline"
    }
  ]
}

Errors

HTTP Status Code	Error Description	Exception Class
422	Unprocessable Entity (WebDAV)	`ErrorArrayMapResponseException`

Update Product Currency Prices

This endpoint allows you to update the prices of currency prices for a given currency that exists on the product price point.

When updating the pricing, it needs to mirror the structure of your primary pricing. If the product price point defines a trial and/or setup fee, each currency must also define a trial and/or setup fee.

Note: Currency Prices are not able to be updated for custom product price points.

UpdateProductCurrencyPrices(
    ctx context.Context,
    productPricePointId int,
    body *models.UpdateCurrencyPricesRequest) (
    models.ApiResponse[models.CurrencyPricesResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`productPricePointId`	`int`	Template, Required	The Chargify id of the product price point
`body`	`*models.UpdateCurrencyPricesRequest`	Body, Optional	-

Response Type

models.CurrencyPricesResponse

Example Usage

ctx := context.Background()

productPricePointId := 234

body := models.UpdateCurrencyPricesRequest{
    CurrencyPrices: []models.UpdateCurrencyPrice{
        models.UpdateCurrencyPrice{
            Id:    200,
            Price: 15,
        },
        models.UpdateCurrencyPrice{
            Id:    201,
            Price: 5,
        },
    },
}

apiResponse, err := productPricePointsController.UpdateProductCurrencyPrices(ctx, productPricePointId, &body)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "currency_prices": [
    {
      "id": 123,
      "currency": "EUR",
      "price": 100,
      "formatted_price": "€123,00",
      "product_price_point_id": 32669,
      "role": "baseline"
    }
  ]
}

Errors

HTTP Status Code	Error Description	Exception Class
422	Unprocessable Entity (WebDAV)	`ErrorArrayMapResponseException`

List All Product Price Points

This method allows retrieval of a list of Products Price Points belonging to a Site.

ListAllProductPricePoints(
    ctx context.Context,
    input ListAllProductPricePointsInput) (
    models.ApiResponse[models.ListProductPricePointsResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`direction`	`*models.SortingDirection`	Query, Optional	Controls the order in which results are returned. Use in query `direction=asc`.
`filter`	`*models.ListPricePointsFilter`	Query, Optional	Filter to use for List PricePoints operations
`include`	`*models.ListProductsPricePointsInclude`	Query, Optional	Allows including additional data in the response. Use in query: `include=currency_prices`.
`page`	`*int`	Query, Optional	Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query `page=1`.
`perPage`	`*int`	Query, Optional	This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200. Use in query `per_page=200`.

Response Type

models.ListProductPricePointsResponse

Example Usage

ctx := context.Background()

collectedInput := advancedbilling.ListAllProductPricePointsInput{
    Filter:    models.ToPointer(models.ListPricePointsFilter{
        StartDate:     models.ToPointer(parseTime(models.DEFAULT_DATE, "2011-12-17", func(err error) { log.Fatalln(err) })),
        EndDate:       models.ToPointer(parseTime(models.DEFAULT_DATE, "2011-12-15", func(err error) { log.Fatalln(err) })),
        StartDatetime: models.ToPointer(parseTime(time.RFC3339, "12/19/2011 09:15:30", func(err error) { log.Fatalln(err) })),
        EndDatetime:   models.ToPointer(parseTime(time.RFC3339, "06/07/2019 17:20:06", func(err error) { log.Fatalln(err) })),
        Type:          []models.PricePointType{
            models.PricePointType("catalog"),
            models.PricePointType("default"),
            models.PricePointType("custom"),
        },
        Ids:           []int{
            1,
            2,
            3,
        },
    }),
    Include:   models.ToPointer(models.ListProductsPricePointsInclude("currency_prices")),
    Page:      models.ToPointer(2),
    PerPage:   models.ToPointer(50),
}

apiResponse, err := productPricePointsController.ListAllProductPricePoints(ctx, collectedInput)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "price_points": [
    {
      "id": 0,
      "name": "My pricepoint",
      "handle": "handle",
      "price_in_cents": 10,
      "interval": 5,
      "interval_unit": "month",
      "trial_price_in_cents": 10,
      "trial_interval": 1,
      "trial_interval_unit": "month",
      "trial_type": "payment_expected",
      "introductory_offer": true,
      "initial_charge_in_cents": 0,
      "initial_charge_after_trial": true,
      "expiration_interval": 0,
      "expiration_interval_unit": "month",
      "product_id": 1230,
      "created_at": "2021-04-02T17:52:09-04:00",
      "updated_at": "2021-04-02T17:52:09-04:00",
      "use_site_exchange_rate": true
    }
  ]
}

Errors

HTTP Status Code	Error Description	Exception Class
422	Unprocessable Entity (WebDAV)	`ErrorListResponseException`

Files

product-price-points.md

Latest commit

History

product-price-points.md

File metadata and controls

Product Price Points

Class Name

Methods

Create Product Price Point

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

List Product Price Points

Parameters

Response Type

Example Usage

Example Response (as JSON)

Update Product Price Point

Parameters

Response Type

Example Usage

Example Response (as JSON)

Read Product Price Point

Parameters

Response Type

Example Usage

Example Response (as JSON)

Archive Product Price Point

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Unarchive Product Price Point

Parameters

Response Type

Example Usage

Example Response (as JSON)

Promote Product Price Point to Default

Parameters

Response Type

Example Usage

Example Response (as JSON)

Bulk Create Product Price Points

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Create Product Currency Prices

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Update Product Currency Prices

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

List All Product Price Points

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors