brevo_python.BalanceApi

All URIs are relative to https://api.brevo.com/v3

Method	HTTP request	Description
begin_transaction	POST /loyalty/balance/programs/{pid}/transactions	Create new transaction
cancel_transaction	POST /loyalty/balance/programs/{pid}/transactions/{tid}/cancel	Cancel transaction
complete_transaction	POST /loyalty/balance/programs/{pid}/transactions/{tid}/complete	Complete transaction
create_balance_limit	POST /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits	Create balance limits
create_balance_order	POST /loyalty/balance/programs/{pid}/create-order	Create balance order
delete_balance_definition	DELETE /loyalty/balance/programs/{pid}/balance-definitions/{bdid}	Delete balance definition
delete_balance_limit	DELETE /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid}	Delete balance limit
get_balance_definition	GET /loyalty/balance/programs/{pid}/balance-definitions/{bdid}	Get balance definition
get_balance_definition_list	GET /loyalty/balance/programs/{pid}/balance-definitions	Get balance definition list
get_balance_limit	GET /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid}	Get balance limits
get_contact_balances	GET /loyalty/balance/programs/{pid}/contact-balances	Get balance list
get_subscription_balances	GET /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances	Get subscription balances
loyalty_balance_programs_pid_active_balance_get	GET /loyalty/balance/programs/{pid}/active-balance	Get Active Balances API
loyalty_balance_programs_pid_balance_definitions_post	POST /loyalty/balance/programs/{pid}/balance-definitions	Create balance definition
loyalty_balance_programs_pid_subscriptions_cid_balances_post	POST /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances	Create subscription balances
loyalty_balance_programs_pid_transaction_history_get	GET /loyalty/balance/programs/{pid}/transaction-history	Get Transaction History API
update_balance_definition	PUT /loyalty/balance/programs/{pid}/balance-definitions/{bdid}	Update balance definition
update_balance_limit	PUT /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid}	Updates balance limit

begin_transaction

Transaction begin_transaction(pid, body)

Create new transaction

Creates new transaction and returns information

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
body = brevo_python.CreateTransactionPayload() # CreateTransactionPayload | Transaction Payload

try:
    # Create new transaction
    api_response = api_instance.begin_transaction(pid, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->begin_transaction: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id
body	CreateTransactionPayload	Transaction Payload

Return type

Transaction

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancel_transaction

Transaction cancel_transaction(pid, tid)

Cancel transaction

Cancels transaction

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
tid = 'tid_example' # str | Transaction Id

try:
    # Cancel transaction
    api_response = api_instance.cancel_transaction(pid, tid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->cancel_transaction: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id
tid	str	Transaction Id

Return type

Transaction

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

complete_transaction

Transaction complete_transaction(pid, tid)

Complete transaction

Completes transaction

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
tid = 'tid_example' # str | Transaction Id

try:
    # Complete transaction
    api_response = api_instance.complete_transaction(pid, tid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->complete_transaction: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id
tid	str	Transaction Id

Return type

Transaction

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_balance_limit

BalanceLimit create_balance_limit(pid, bdid, body)

Create balance limits

Creates balance limit and sends the created UUID along with the data

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
bdid = 'bdid_example' # str | Balance Definition Id
body = brevo_python.CreateBalanceLimitPayload() # CreateBalanceLimitPayload | Balance Definition Payload

try:
    # Create balance limits
    api_response = api_instance.create_balance_limit(pid, bdid, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->create_balance_limit: %s\n" % e)

Parameters

Name	Type	Description
pid	str	Loyalty Program Id
bdid	str	Balance Definition Id
body	CreateBalanceLimitPayload	Balance Definition Payload

Return type

BalanceLimit

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_balance_order

BalanceOrder create_balance_order(pid, body)

Create balance order

Returns created order

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
body = brevo_python.CreateOrderPayload() # CreateOrderPayload | Order Payload

try:
    # Create balance order
    api_response = api_instance.create_balance_order(pid, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->create_balance_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id
body	CreateOrderPayload	Order Payload

Return type

BalanceOrder

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_balance_definition

delete_balance_definition(pid, bdid)

Delete balance definition

Delete Balance definition

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
bdid = 'bdid_example' # str | Balance Definition Id

try:
    # Delete balance definition
    api_instance.delete_balance_definition(pid, bdid)
except ApiException as e:
    print("Exception when calling BalanceApi->delete_balance_definition: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id
bdid	str	Balance Definition Id

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_balance_limit

delete_balance_limit(pid, bdid, blid)

Delete balance limit

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
bdid = 'bdid_example' # str | Balance Definition Id
blid = 'blid_example' # str | Balance Limit Id

try:
    # Delete balance limit
    api_instance.delete_balance_limit(pid, bdid, blid)
except ApiException as e:
    print("Exception when calling BalanceApi->delete_balance_limit: %s\n" % e)

Parameters

Name	Type	Description
pid	str	Loyalty Program Id
bdid	str	Balance Definition Id
blid	str	Balance Limit Id

Return type

void (empty response body)

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_balance_definition

BalanceDefinition get_balance_definition(pid, bdid, version=version)

Get balance definition

Returns balance definition

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
bdid = 'bdid_example' # str | Balance Definition Id
version = 'draft' # str | Version (optional) (default to draft)

try:
    # Get balance definition
    api_response = api_instance.get_balance_definition(pid, bdid, version=version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->get_balance_definition: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id
bdid	str	Balance Definition Id
version	str	Version	[optional] [default to draft]

Return type

BalanceDefinition

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_balance_definition_list

BalanceDefinitionPage get_balance_definition_list(pid, limit=limit, offset=offset, sort_field=sort_field, sort=sort, version=version)

Get balance definition list

Returns balance definition page

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
limit = 200 # int | Limit the number of records returned (optional) (default to 200)
offset = 0 # int | Offset to paginate records (optional) (default to 0)
sort_field = 'updated_at' # str | Field to sort by (optional) (default to updated_at)
sort = 'desc' # str | Sort direction (optional) (default to desc)
version = 'draft' # str | Version (optional) (default to draft)

try:
    # Get balance definition list
    api_response = api_instance.get_balance_definition_list(pid, limit=limit, offset=offset, sort_field=sort_field, sort=sort, version=version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->get_balance_definition_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id
limit	int	Limit the number of records returned	[optional] [default to 200]
offset	int	Offset to paginate records	[optional] [default to 0]
sort_field	str	Field to sort by	[optional] [default to updated_at]
sort	str	Sort direction	[optional] [default to desc]
version	str	Version	[optional] [default to draft]

Return type

BalanceDefinitionPage

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_balance_limit

BalanceLimit get_balance_limit(pid, bdid, blid, version=version)

Get balance limits

Fetches balance limits and send the created UUID along with the data

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
bdid = 'bdid_example' # str | Balance Definition Id
blid = 'blid_example' # str | Balance Limit Id
version = 'draft' # str | Version (optional) (default to draft)

try:
    # Get balance limits
    api_response = api_instance.get_balance_limit(pid, bdid, blid, version=version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->get_balance_limit: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id
bdid	str	Balance Definition Id
blid	str	Balance Limit Id
version	str	Version	[optional] [default to draft]

Return type

BalanceLimit

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_contact_balances

ContactBalancesResp get_contact_balances(pid)

Get balance list

Returns balance list

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id

try:
    # Get balance list
    api_response = api_instance.get_contact_balances(pid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->get_contact_balances: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id

Return type

ContactBalancesResp

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_subscription_balances

ModelSubscriptionBalanceResp get_subscription_balances(cid, pid)

Get subscription balances

Returns subscription balances

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
cid = 'cid_example' # str | Contact Id
pid = 'pid_example' # str | Loyalty Program Id

try:
    # Get subscription balances
    api_response = api_instance.get_subscription_balances(cid, pid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->get_subscription_balances: %s\n" % e)

Parameters

Name	Type	Description	Notes
cid	str	Contact Id
pid	str	Loyalty Program Id

Return type

ModelSubscriptionBalanceResp

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

loyalty_balance_programs_pid_active_balance_get

BalanceLimit loyalty_balance_programs_pid_active_balance_get(pid, contact_id, balance_definition_id, limit=limit, offset=offset, sort_field=sort_field, sort=sort)

Get Active Balances API

Returns Active Balances

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
contact_id = 56 # int | Contact ID
balance_definition_id = 'balance_definition_id_example' # str | Balance Definition ID
limit = 56 # int | Limit (optional)
offset = 56 # int | Offset (optional)
sort_field = 'sort_field_example' # str | Sort Field (optional)
sort = 'sort_example' # str | Sort Order (optional)

try:
    # Get Active Balances API
    api_response = api_instance.loyalty_balance_programs_pid_active_balance_get(pid, contact_id, balance_definition_id, limit=limit, offset=offset, sort_field=sort_field, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->loyalty_balance_programs_pid_active_balance_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id
contact_id	int	Contact ID
balance_definition_id	str	Balance Definition ID
limit	int	Limit	[optional]
offset	int	Offset	[optional]
sort_field	str	Sort Field	[optional]
sort	str	Sort Order	[optional]

Return type

BalanceLimit

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

loyalty_balance_programs_pid_balance_definitions_post

BalanceDefinition loyalty_balance_programs_pid_balance_definitions_post(pid, body)

Create balance definition

Creates balance definition and returns information

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
body = brevo_python.CreateBalanceDefinitionPayload() # CreateBalanceDefinitionPayload | Create Balance Definition Payload

try:
    # Create balance definition
    api_response = api_instance.loyalty_balance_programs_pid_balance_definitions_post(pid, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->loyalty_balance_programs_pid_balance_definitions_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id
body	CreateBalanceDefinitionPayload	Create Balance Definition Payload

Return type

BalanceDefinition

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

loyalty_balance_programs_pid_subscriptions_cid_balances_post

Balance loyalty_balance_programs_pid_subscriptions_cid_balances_post(pid, cid, body)

Create subscription balances

Creates a balance for a contact

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
cid = 'cid_example' # str | Contact Id
body = brevo_python.CreateBalancePayload() # CreateBalancePayload | Create Balnce Payload

try:
    # Create subscription balances
    api_response = api_instance.loyalty_balance_programs_pid_subscriptions_cid_balances_post(pid, cid, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->loyalty_balance_programs_pid_subscriptions_cid_balances_post: %s\n" % e)

Parameters

Name	Type	Description
pid	str	Loyalty Program Id
cid	str	Contact Id
body	CreateBalancePayload	Create Balnce Payload

Return type

Balance

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

loyalty_balance_programs_pid_transaction_history_get

TransactionHistoryResp loyalty_balance_programs_pid_transaction_history_get(pid, contact_id, balance_definition_id, limit=limit, offset=offset, sort_field=sort_field, sort=sort, filters=filters)

Get Transaction History API

Returns transaction history

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
contact_id = 0 # int | Contact ID (default to 0)
balance_definition_id = 'balance_definition_id_example' # str | Balance Definition ID
limit = 20 # int | Limit the number of records returned (optional) (default to 20)
offset = 0 # int | Skip a number of records (optional) (default to 0)
sort_field = 'created_at' # str | Field to sort by (optional) (default to created_at)
sort = 'desc' # str | Sort order, either asc or desc (optional) (default to desc)
filters = ['filters_example'] # list[str] | Filters to apply (optional)

try:
    # Get Transaction History API
    api_response = api_instance.loyalty_balance_programs_pid_transaction_history_get(pid, contact_id, balance_definition_id, limit=limit, offset=offset, sort_field=sort_field, sort=sort, filters=filters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->loyalty_balance_programs_pid_transaction_history_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
pid	str	Loyalty Program Id
contact_id	int	Contact ID	[default to 0]
balance_definition_id	str	Balance Definition ID
limit	int	Limit the number of records returned	[optional] [default to 20]
offset	int	Skip a number of records	[optional] [default to 0]
sort_field	str	Field to sort by	[optional] [default to created_at]
sort	str	Sort order, either asc or desc	[optional] [default to desc]
filters	list[str]	Filters to apply	[optional]

Return type

TransactionHistoryResp

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_balance_definition

BalanceDefinition update_balance_definition(pid, bdid, body)

Update balance definition

Updates Balance definition

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
bdid = 'bdid_example' # str | Balance Definition Id
body = brevo_python.UpdateBalanceDefinitionPayload() # UpdateBalanceDefinitionPayload | Update Balance Definition Payload

try:
    # Update balance definition
    api_response = api_instance.update_balance_definition(pid, bdid, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->update_balance_definition: %s\n" % e)

Parameters

Name	Type	Description
pid	str	Loyalty Program Id
bdid	str	Balance Definition Id
body	UpdateBalanceDefinitionPayload	Update Balance Definition Payload

Return type

BalanceDefinition

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_balance_limit

BalanceLimit update_balance_limit(pid, bdid, blid, body)

Updates balance limit

Example

from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = brevo_python.BalanceApi(brevo_python.ApiClient(configuration))
pid = 'pid_example' # str | Loyalty Program Id
bdid = 'bdid_example' # str | Balance Definition Id
blid = 'blid_example' # str | Balance Limit Id
body = brevo_python.UpdateBalanceLimitPayload() # UpdateBalanceLimitPayload | Balance Limits Payload

try:
    # Updates balance limit
    api_response = api_instance.update_balance_limit(pid, bdid, blid, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BalanceApi->update_balance_limit: %s\n" % e)

Parameters

Name	Type	Description
pid	str	Loyalty Program Id
bdid	str	Balance Definition Id
blid	str	Balance Limit Id
body	UpdateBalanceLimitPayload	Balance Limits Payload

Return type

BalanceLimit

Authorization

api-key, partner-key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

BalanceApi.md

Latest commit

History

BalanceApi.md

File metadata and controls

brevo_python.BalanceApi

begin_transaction

Example

Parameters

Return type

Authorization

HTTP request headers

cancel_transaction

Example

Parameters

Return type

Authorization

HTTP request headers

complete_transaction

Example

Parameters

Return type

Authorization

HTTP request headers

create_balance_limit

Example

Parameters

Return type

Authorization

HTTP request headers

create_balance_order

Example

Parameters

Return type

Authorization

HTTP request headers

delete_balance_definition

Example

Parameters

Return type

Authorization

HTTP request headers

delete_balance_limit

Example

Parameters

Return type

Authorization

HTTP request headers

get_balance_definition

Example

Parameters

Return type

Authorization

HTTP request headers

get_balance_definition_list

Example

Parameters

Return type

Authorization

HTTP request headers

get_balance_limit

Example

Parameters

Return type

Authorization

HTTP request headers

get_contact_balances

Example

Parameters

Return type

Authorization

HTTP request headers

get_subscription_balances

Example

Parameters

Return type

Authorization

HTTP request headers

loyalty_balance_programs_pid_active_balance_get