GSAPI Pricing Change

Version: 2026_1
Audience: Customers and integrators updating pricing programmatically
Purpose: Explain how to update pricing using GSAPI, how bulk changes work through Excel import, and how to interpret the results.

1. Overview

Good Sign provides a dedicated GSAPI endpoint for updating pricing lines.
This allows you to:

• change prices via API
• update multiple prices at once
• set validity ranges for new prices
• adjust prices by amount or percentage
• use Excel imports for bulk updates

The Pricing Change endpoint was introduced to simplify pricing maintenance without editing contract line volumes or pricing model details.

2. Required User Rights

To change prices using GSAPI or Excel import, the following rights are required:

These rights are typically included in Admin and Pricing Specialist profiles.

3. Endpoint

Standard cloud environment URL:

POST https://api.goodsign.cloud/api/interface/gsapi/pricing/change

This endpoint accepts JSON for single or multiple price changes.

4. Updating Prices Through GSAPI (JSON)

A typical request requires only three fields:

• pricing_id – identifier of the pricing line
• price – new price
• pricevalidfrom – start date/time for when the new price becomes active

Minimal example

[
  {
    "pricing_id": 12345,
    "price": 29.90,
    "pricevalidfrom": "2026-03-15"
  }
] 

Figure 1: Example JSON Pricing Change request

Response example

{
  "ret": 1,
  "old_pricing": 25.00,
  "new_pricing": 29.90
} 

This shows the old value and the newly created pricing row.

5. Updating Prices Using Excel Import

Multiple pricing changes can be made at once using an Excel file.

Step 1: Export your current prices

In the UI, go to:

Prices → Export to Excel

This produces an Excel sheet with user-friendly column names.

Step 2: Adjust column names

Miikka’s original instructions clarify that you must rename at least:

• Pricing ID → pricing_id
• Valid From → pricevalidfrom

Figure 2: Excel export with pricing_id and pricevalidfrom fields

Step 3: Create the interface

In the UI:

1. Open Interfaces
2. Select Add New Interface
3. Choose Change Prices as the action

Figure 3: Selecting “Change Prices” in Interface settings

Step 4: Import your Excel file

Use:

Interfaces → Data Inbound Settings → Import File

Good Sign stages the Excel rows and prepares them for execution.

Step 5: Execute

Press Execute to apply the changes.

Figure 4: Confirmation of successful Pricing Change import

After execution, the new pricing lines become available based on the pricevalidfrom date.

6. Supported Parameters

These parameters can be included in your JSON or Excel import:

Rules:

• price overrides change_amount and change_percentage.
• Validity dates can be left empty when updating only current prices.

7. Processing Behavior

Pricing changes generate new pricing records with updated:

• price
• validity period
• pricing ID lineage

The old price remains in history until replaced.

Excel imports use interface execution, which means:

• rows are staged first
• execution applies changes
• errors are visible in Raw Data tab

8. Troubleshooting (Errors & Validation)

Common issues:

Errors appear either in:

• GSAPI ret response (for JSON imports), or
• Interface “Raw Data” tab (for Excel imports).

9. Summary

10. Consultant Notes (Advanced)

Validity Logic

Multiple pricing rows for the same pricing_id create a time-sequenced history. Overlaps may require manual adjustments.

Performance

Large Excel imports should be executed in batches to avoid staging congestion.

Data Lineage

New prices are added as new pricing rows, not edits to existing rows.
This maintains auditability.

API vs Excel

API is preferred for automated systems; Excel is recommended for bulk one-off updates.