Customers

List customer tariffs

Returns tariffs available for a specific customer, filtered by the customer's profile attributes.

Filtering logic

Only tariffs marked as available_for_services = true are returned (for one-time tariffs: enabled = true).

Tariffs are then filtered based on the customer's profile:

FilterLogic
Portal visibilityAdmin requests: excludes tariffs with hide_on_admin_portal = true. Customer requests: only includes tariffs with show_on_customer_portal = true.
PartnerTariff's partners_ids must include the customer's partner_id.
Billing typeTariff's billing_types must include the customer's billing_type.
LocationIf the tariff has available_for_locations set, the customer's location_id must be in the list.
CategoryIf the tariff has customer_categories set, the customer's category must match.
LabelsIf the tariff requires customer_labels, the customer must have all of them. If the customer has no labels, the tariff is excluded.

A tariff type is only included in the response if the corresponding module (Internet, Voice, Recurring, One-Time, Bundle) is enabled in the system.

Response structure

When no types filter is applied or multiple types are requested, the response is an object keyed by tariff type.

When exactly one type is requested (e.g. types[]=internet), the response is a flat array of tariffs of that type.

Bundle tariffs include embedded internet_tariffs, voice_tariffs, and recurring_tariffs arrays.

Customer vs Admin access

Both admin and customer users can call this endpoint. Customers can only request their own tariffs (the id must match the authenticated customer). For customer requests, partners_ids and billing_types fields are hidden from each tariff object in the response.

get/admin/customers/customer-tariffs/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/customers/customer-tariffs/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired customer.

Query parameters

types[]string[]

Filter response to specific tariff types. Can be passed multiple times to request several types. If omitted, all available types are returned.

Response

Tariffs available for the customer, grouped by type (or flat array if single type requested).

internetobject[]

Internet tariffs available for the customer.

voiceobject[]

Voice tariffs available for the customer.

recurringobject[]

Recurring tariffs available for the customer.

one-timeobject[]

One-time tariffs available for the customer.

bundleobject[]

Bundle tariffs with embedded internet_tariffs, voice_tariffs, recurring_tariffs.

Changes

No recorded changes to this operation across all 1 revision of this API.