Search code, repositories, users, issues, pull requests...

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

Authorization

No authorization required

HTTP request headers

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

add_credit_note_to_subscription

CreditNotePagedMetadata add_credit_note_to_subscription(subscription_id, credit_note)

Creates a credit-note which may be used by only the specified subscription.

{"nickname":"Add Credit","request":"addCreditNoteToSubscriptionRequest.html", "response":"addCreditNoteToSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | ID of the subscription.
credit_note = billforward.CreditSubscriptionRequest() # CreditSubscriptionRequest | The credit-note request

try: 
    # Creates a credit-note which may be used by only the specified subscription.
    api_response = api_instance.add_credit_note_to_subscription(subscription_id, credit_note)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->add_credit_note_to_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str	ID of the subscription.
credit_note	CreditSubscriptionRequest	The credit-note request

Return type

CreditNotePagedMetadata

Authorization

No authorization required

HTTP request headers

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

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

add_payment_method_to_subscription

PaymentMethodPagedMetadata add_payment_method_to_subscription(subscription_id, payment_method)

Enables the payment method to pay invoices of this subscription.

{"nickname":"Add payment-method to subscription","response":"addPaymentMethod.html","request":"addPaymentMethod.request.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
payment_method = billforward.AddPaymentMethodRequest() # AddPaymentMethodRequest | 

try: 
    # Enables the payment method to pay invoices of this subscription.
    api_response = api_instance.add_payment_method_to_subscription(subscription_id, payment_method)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->add_payment_method_to_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
payment_method	AddPaymentMethodRequest

Return type

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

Authorization

No authorization required

HTTP request headers

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

advance_subscription

TimeResponsePagedMetadata advance_subscription(subscription_id, request)

Advance the subscription through time.

{"nickname":"Advance","request":"advanceSubscriptionRequest.html","response":"advanceSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | ID of the subscription.
request = billforward.TimeRequest() # TimeRequest | The request

try: 
    # Advance the subscription through time.
    api_response = api_instance.advance_subscription(subscription_id, request)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->advance_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str	ID of the subscription.
request	TimeRequest	The request

Return type

TimeResponsePagedMetadata

Authorization

No authorization required

HTTP request headers

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

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

available_payment_methods_for_subscription

PaymentMethodPagedMetadata available_payment_methods_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)

Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order.

{ "nickname" : "List on subscription","response" : "getAvailablePaymentMethods.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)

try: 
    # Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.available_payment_methods_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->available_payment_methods_for_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to id]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

batch_create_subscriptions

SubscriptionPagedMetadata batch_create_subscriptions(request)

Create multiple subscriptions.

{"nickname":"Create multiple subscriptions","response":"createMultipleSubscriptionViaHelper.html","request":"createMultipleSubscriptionViaHelper.request.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
request = billforward.CreateSubscriptionBatchRequest() # CreateSubscriptionBatchRequest | 

try: 
    # Create multiple subscriptions.
    api_response = api_instance.batch_create_subscriptions(request)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->batch_create_subscriptions: %s\n" % e

Parameters

Name	Type	Description	Notes
request	CreateSubscriptionBatchRequest

Return type

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

Authorization

No authorization required

HTTP request headers

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

cancel_subscription

SubscriptionCancellationPagedMetadata cancel_subscription(subscription_id, subscription_cancellation)

Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product.

{"nickname":"Cancel subscription","response":"deleteSubscription.html","request":"deleteSubscriptionRequest.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
subscription_cancellation = billforward.CancelSubscriptionRequest() # CancelSubscriptionRequest | The cancellation request

try: 
    # Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product.
    api_response = api_instance.cancel_subscription(subscription_id, subscription_cancellation)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->cancel_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
subscription_cancellation	CancelSubscriptionRequest	The cancellation request

Return type

SubscriptionCancellationPagedMetadata

Authorization

No authorization required

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_aggregating_subscription

SubscriptionPagedMetadata create_aggregating_subscription(request)

Create an aggregating subscription.

{"nickname":"Create aggregating subscription","response":"createAggregatingSubscription.html","request":"createAggregatingSubscription.request.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
request = billforward.CreateAggregatingSubscriptionRequest() # CreateAggregatingSubscriptionRequest | 

try: 
    # Create an aggregating subscription.
    api_response = api_instance.create_aggregating_subscription(request)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->create_aggregating_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
request	CreateAggregatingSubscriptionRequest

Return type

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

Authorization

No authorization required

HTTP request headers

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

create_subscription

SubscriptionPagedMetadata create_subscription(subscription)

Create a new subscription.

{"nickname":"Create a new subscription","request":"createSubscriptionRequest.html","response":"createSubscriptionResponse.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription = billforward.Subscription() # Subscription | The subscription object to be updated.

try: 
    # Create a new subscription.
    api_response = api_instance.create_subscription(subscription)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->create_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription	Subscription	The subscription object to be updated.

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: text/xml, application/xml, application/json

create_subscription_v2

SubscriptionPagedMetadata create_subscription_v2(request)

Create a subscription (V2).

{"nickname":"Create a subscription (V2)","response":"createSubscriptionViaHelper.html","request":"createSubscriptionViaHelper.request.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
request = billforward.CreateSubscriptionRequest() # CreateSubscriptionRequest | 

try: 
    # Create a subscription (V2).
    api_response = api_instance.create_subscription_v2(request)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->create_subscription_v2: %s\n" % e

Parameters

Name	Type	Description	Notes
request	CreateSubscriptionRequest

Return type

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

Authorization

No authorization required

HTTP request headers

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

create_timer

TimerAmendment create_timer(subscription_id, request)

Create a timer for a subscription event.

{"nickname":"Create Timer","response":"createSubscriptionTimer.html","request":"createSubscriptionTimer.request.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
request = billforward.BillingEntityBase() # BillingEntityBase | 

try: 
    # Create a timer for a subscription event.
    api_response = api_instance.create_timer(subscription_id, request)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->create_timer: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
request	BillingEntityBase

Return type

TimerAmendment

Authorization

No authorization required

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_metadata_for_subscription

DynamicMetadata delete_metadata_for_subscription(subscription_id, organizations=organizations)

Remove any associated metadata.

{"nickname":"Clear from subscription","request" :"deleteSubscriptionMetadataRequest.html","response":"deleteSubscriptionMetadataResponse.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)

try: 
    # Remove any associated metadata.
    api_response = api_instance.delete_metadata_for_subscription(subscription_id, organizations=organizations)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->delete_metadata_for_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

freeze_subscription

SubscriptionPagedMetadata freeze_subscription(subscription_id, request)

Freeze the subscription.

{"nickname":"Freeze","request":"freezeSubscriptionRequest.html","response":"freezeSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | ID of the subscription.
request = billforward.PauseRequest() # PauseRequest | The request

try: 
    # Freeze the subscription.
    api_response = api_instance.freeze_subscription(subscription_id, request)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->freeze_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str	ID of the subscription.
request	PauseRequest	The request

Return type

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

Authorization

No authorization required

HTTP request headers

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

get_all_subscriptions

SubscriptionPagedMetadata get_all_subscriptions(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children, metadata=metadata, exclude_service_ended=exclude_service_ended, account_id=account_id)

Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve all subscriptions","response":"getSubscriptionAll.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)
include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false)
exclude_children = true # bool | Should child subscriptiosn be excluded. (optional) (default to true)
metadata = 'metadata_example' # str |  (optional)
exclude_service_ended = true # bool |  (optional)
account_id = ['account_id_example'] # list[str] | A list of accountIDs to filter subscriptions on (optional)

try: 
    # Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_all_subscriptions(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children, metadata=metadata, exclude_service_ended=exclude_service_ended, account_id=account_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_all_subscriptions: %s\n" % e

Parameters

Name	Type	Description	Notes
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to created]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	bool	Whether retired subscriptions should be returned.	[optional] [default to false]
exclude_children	bool	Should child subscriptiosn be excluded.	[optional] [default to true]
metadata	str		[optional]
exclude_service_ended	bool		[optional]
account_id	list[str]	A list of accountIDs to filter subscriptions on	[optional]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_applicable_coupons_for_subscription

CouponPagedMetadata get_applicable_coupons_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired)

Retrieves a collection of the coupons which can be applied to this subscription.

{ "nickname" : "Retrieve applicable coupons","response" : "getApplicableCoupons.html" }

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | ID of the subscription.
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)
include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false)

try: 
    # Retrieves a collection of the coupons which can be applied to this subscription.
    api_response = api_instance.get_applicable_coupons_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_applicable_coupons_for_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str	ID of the subscription.
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to created]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	bool	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_available_credit_subscription

CreditNotePagedMetadata get_available_credit_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired)

Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Get available credit","response":"getAvailableCreditSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)
include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false)

try: 
    # Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_available_credit_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_available_credit_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to id]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	bool	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

CreditNotePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

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

get_charges_on_subscription

SubscriptionChargePagedMetadata get_charges_on_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, state=state, type=type, include_retired=include_retired)

Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Get charges","response":"getChargesSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)
state = 'state_example' # str | Ihe direction of any ordering, either ASC or DESC. (optional)
type = 'type_example' # str | Ihe direction of any ordering, either ASC or DESC. (optional)
include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false)

try: 
    # Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_charges_on_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, state=state, type=type, include_retired=include_retired)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_charges_on_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to created]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
state	str	Ihe direction of any ordering, either ASC or DESC.	[optional]
type	str	Ihe direction of any ordering, either ASC or DESC.	[optional]
include_retired	bool	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

SubscriptionChargePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

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

get_children_of_subscription

SubscriptionPagedMetadata get_children_of_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired)

Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order.

{"nickname":"Get Aggregated Entities","response":"getAggregatedEntities.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)
include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false)

try: 
    # Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_children_of_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_children_of_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to created]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	bool	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_coupons_on_subscription

CouponPagedMetadata get_coupons_on_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired)

Retrieves a collection of the coupons and the unique codes currently applied to the subscription.

{"nickname":"Retrieve coupons","response":"getCoupons.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | ID of the subscription.
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)
include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false)

try: 
    # Retrieves a collection of the coupons and the unique codes currently applied to the subscription.
    api_response = api_instance.get_coupons_on_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_coupons_on_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str	ID of the subscription.
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to created]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	bool	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_invoices_for_subscription_by_state

InvoicePagedMetadata get_invoices_for_subscription_by_state(subscription_id, state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)

Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve invoices by state for subscription","response":"getInvoicesForSubscriptionByState.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | The unique id of the subscription.
state = 'state_example' # str | The state of the invoices to retrieve.
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0)
records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10)
order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)

try: 
    # Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_invoices_for_subscription_by_state(subscription_id, state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_invoices_for_subscription_by_state: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str	The unique id of the subscription.
state	str	The state of the invoices to retrieve.
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first taxation-link to return.	[optional] [default to 0]
records	int	The maximum number of taxation-links to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to created]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

InvoicePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

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

get_metadata_for_subscription

DynamicMetadata get_metadata_for_subscription(subscription_id, organizations=organizations)

Retrieve any associated metadata.

{"nickname":"Retrieve on subscription","request":"getSubscriptionMetadataRequest.html","response":"getSubscriptionMetadataResponse.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)

try: 
    # Retrieve any associated metadata.
    api_response = api_instance.get_metadata_for_subscription(subscription_id, organizations=organizations)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_metadata_for_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_parent_subscription

SubscriptionPagedMetadata get_parent_subscription(subscription_id, organizations=organizations)

Return the parent of the given subscription.

{"nickname":"Get parent","response":"getParentSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)

try: 
    # Return the parent of the given subscription.
    api_response = api_instance.get_parent_subscription(subscription_id, organizations=organizations)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_parent_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_pricing_component_values_of_subscription

PricingComponentValuePagedMetadata get_pricing_component_values_of_subscription(subscription_id)

Gets the subscription's current pricing-component values.

{"nickname":"Get values","response":"getPricingComponentValues.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | ID of the subscription.

try: 
    # Gets the subscription's current pricing-component values.
    api_response = api_instance.get_pricing_component_values_of_subscription(subscription_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_pricing_component_values_of_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str	ID of the subscription.

Return type

PricingComponentValuePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

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

get_subscription_by_account_id

SubscriptionPagedMetadata get_subscription_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children)

Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by account","response":"getSubscriptionByAccount.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
account_id = 'account_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)
include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false)
exclude_children = true # bool | Should child subscriptiosn be excluded. (optional) (default to true)

try: 
    # Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_subscription_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_subscription_by_account_id: %s\n" % e

Parameters

Name	Type	Description	Notes
account_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to id]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	bool	Whether retired subscriptions should be returned.	[optional] [default to false]
exclude_children	bool	Should child subscriptiosn be excluded.	[optional] [default to true]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_subscription_by_id

SubscriptionPagedMetadata get_subscription_by_id(subscription_id, organizations=organizations, include_retired=include_retired)

Retrieves a single subscription, specified by the ID parameter.

{"nickname":"Retrieve an existing subscription","response":"getSubscriptionByID.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false)

try: 
    # Retrieves a single subscription, specified by the ID parameter.
    api_response = api_instance.get_subscription_by_id(subscription_id, organizations=organizations, include_retired=include_retired)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_subscription_by_id: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
include_retired	bool	Whether retired subscriptions should be returned.	[optional] [default to false]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_subscription_by_product_id

SubscriptionPagedMetadata get_subscription_by_product_id(product_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children)

Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by product","response":"getSubscriptionByProduct.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
product_id = 'product_id_example' # str | ID of the product
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)
include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false)
exclude_children = true # bool | Should child subscriptiosn be excluded. (optional) (default to true)

try: 
    # Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_subscription_by_product_id(product_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_subscription_by_product_id: %s\n" % e

Parameters

Name	Type	Description	Notes
product_id	str	ID of the product
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to id]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	bool	Whether retired subscriptions should be returned.	[optional] [default to false]
exclude_children	bool	Should child subscriptiosn be excluded.	[optional] [default to true]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_subscription_by_product_rate_plan_id

SubscriptionPagedMetadata get_subscription_by_product_rate_plan_id(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children)

Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by rate-plan","response":"getSubscriptionByProductRatePlan.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
product_rate_plan_id = 'product_rate_plan_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)
include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false)
exclude_children = true # bool | Should child subscriptiosn be excluded. (optional) (default to true)

try: 
    # Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_subscription_by_product_rate_plan_id(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_subscription_by_product_rate_plan_id: %s\n" % e

Parameters

Name	Type	Description	Notes
product_rate_plan_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to id]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	bool	Whether retired subscriptions should be returned.	[optional] [default to false]
exclude_children	bool	Should child subscriptiosn be excluded.	[optional] [default to true]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_subscription_by_state

SubscriptionPagedMetadata get_subscription_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children)

Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by state","response":"getSubscriptionByState.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
state = 'state_example' # str | The current state of the subscription, either Provisioned, AwaitingPayment, Paid or Cancelled
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)
include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false)
exclude_children = true # bool | Should child subscriptiosn be excluded. (optional) (default to true)

try: 
    # Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_subscription_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_subscription_by_state: %s\n" % e

Parameters

Name	Type	Description	Notes
state	str	The current state of the subscription, either Provisioned, AwaitingPayment, Paid or Cancelled
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to id]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	bool	Whether retired subscriptions should be returned.	[optional] [default to false]
exclude_children	bool	Should child subscriptiosn be excluded.	[optional] [default to true]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_subscription_by_version_id

SubscriptionPagedMetadata get_subscription_by_version_id(version_id, organizations=organizations)

Retrieves a single subscription, specified by the version-ID parameter.

{"nickname":"Retrieve by version","response":"getSubscriptionByVersionID.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
version_id = 'version_id_example' # str | The version-ID of the subscription.
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)

try: 
    # Retrieves a single subscription, specified by the version-ID parameter.
    api_response = api_instance.get_subscription_by_version_id(version_id, organizations=organizations)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_subscription_by_version_id: %s\n" % e

Parameters

Name	Type	Description	Notes
version_id	str	The version-ID of the subscription.
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_subscriptions_by_initial_period_start

SubscriptionPagedMetadata get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)

Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by initial period-start","response":"getSubscriptionByInitialPeriodStart.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period.
upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period.
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0)
records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10)
order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)

try: 
    # Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_subscriptions_by_initial_period_start: %s\n" % e

Parameters

Name	Type	Description	Notes
lower_threshold	str	The UTC DateTime specifying the start of the result period.
upper_threshold	str	The UTC DateTime specifying the end of the result period.
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first taxation-link to return.	[optional] [default to 0]
records	int	The maximum number of taxation-links to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to created]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_subscriptions_by_period_end

SubscriptionPagedMetadata get_subscriptions_by_period_end(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)

{"nickname":"Retrieve by period-end","response":"getSubscriptionByPeriodEnd.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period.
upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period.
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0)
records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10)
order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)

try: 
    # Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_subscriptions_by_period_end(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_subscriptions_by_period_end: %s\n" % e

Parameters

Name	Type	Description	Notes
lower_threshold	str	The UTC DateTime specifying the start of the result period.
upper_threshold	str	The UTC DateTime specifying the end of the result period.
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first taxation-link to return.	[optional] [default to 0]
records	int	The maximum number of taxation-links to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to created]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_subscriptions_by_period_start

SubscriptionPagedMetadata get_subscriptions_by_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)

Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by period-start","response":"getSubscriptionByPeriodStart.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period.
upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period.
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0)
records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10)
order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)

try: 
    # Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_subscriptions_by_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_subscriptions_by_period_start: %s\n" % e

Parameters

Name	Type	Description	Notes
lower_threshold	str	The UTC DateTime specifying the start of the result period.
upper_threshold	str	The UTC DateTime specifying the end of the result period.
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first taxation-link to return.	[optional] [default to 0]
records	int	The maximum number of taxation-links to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to created]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_subscriptions_by_successful_periods

SubscriptionPagedMetadata get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)

Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Retrieve by successful period","response":"getSubscriptionBySuccessfulPeriods.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
lower_threshold = 56 # int | The lower threshold of the range
upper_threshold = 56 # int | The upper threshold of the range.
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0)
records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10)
order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)

try: 
    # Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_subscriptions_by_successful_periods: %s\n" % e

Parameters

Name	Type	Description	Notes
lower_threshold	int	The lower threshold of the range
upper_threshold	int	The upper threshold of the range.
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first taxation-link to return.	[optional] [default to 0]
records	int	The maximum number of taxation-links to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to created]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

get_swagger_subscription

SwaggerTypeListSubs get_swagger_subscription(query_string, organizations=organizations, offset=offset, records=records, format=format, wildcard=wildcard, entity=entity)

{ "nickname" : "","response" : ""}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
query_string = 'query_string_example' # str | The query string used to search.
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The starting index of the search results. (optional) (default to 0)
records = 10 # int | The number of search results to return. (optional) (default to 10)
format = 'JSON' # str | The response format, either JSON or XML. (optional) (default to JSON)
wildcard = false # bool | Toggle if we search for full words or whether a wildcard is used. (optional) (default to false)
entity = false # bool | Is an entity returned with the search results. (optional) (default to false)

try: 
    # 
    api_response = api_instance.get_swagger_subscription(query_string, organizations=organizations, offset=offset, records=records, format=format, wildcard=wildcard, entity=entity)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_swagger_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
query_string	str	The query string used to search.
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The starting index of the search results.	[optional] [default to 0]
records	int	The number of search results to return.	[optional] [default to 10]
format	str	The response format, either JSON or XML.	[optional] [default to JSON]
wildcard	bool	Toggle if we search for full words or whether a wildcard is used.	[optional] [default to false]
entity	bool	Is an entity returned with the search results.	[optional] [default to false]

Return type

SwaggerTypeListSubs

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

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

get_timers_for_subscription

TimerAmendment get_timers_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, state=state, event=event)

Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order.

{"nickname":"Get Timers","response":"getTimersforSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)
offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0)
records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10)
order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created)
order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC)
include_retired = false # bool | Whether retired timers should be returned. (optional) (default to false)
state = 'state_example' # str | The state of the timer amendment (optional)
event = 'event_example' # str | The type of timer event (optional)

try: 
    # Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order.
    api_response = api_instance.get_timers_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, state=state, event=event)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->get_timers_for_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]
offset	int	The offset from the first subscription to return.	[optional] [default to 0]
records	int	The maximum number of subscriptions to return.	[optional] [default to 10]
order_by	str	Specify a field used to order the result set.	[optional] [default to created]
order	str	Ihe direction of any ordering, either ASC or DESC.	[optional] [default to DESC]
include_retired	bool	Whether retired timers should be returned.	[optional] [default to false]
state	str	The state of the timer amendment	[optional]
event	str	The type of timer event	[optional]

Return type

TimerAmendment

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

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

import_subscription

SubscriptionPagedMetadata import_subscription(request)

Import a subscription.

{"nickname":"Import","request":"importSubscriptionRequest.html","response":"importSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
request = billforward.BillingEntityBase() # BillingEntityBase | The request

try: 
    # Import a subscription.
    api_response = api_instance.import_subscription(request)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->import_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
request	BillingEntityBase	The request

Return type

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

Authorization

No authorization required

HTTP request headers

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

invoice_charges_on_subscription

InvoicePagedMetadata invoice_charges_on_subscription(subscription_id, charge)

Invoice any outstanding charges for the subscription.

{"nickname":"Invoice Charges","request":"invoiceChargesRequest.html","response":"invoiceCharges.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | ID of the subscription.
charge = billforward.InvoiceChargeRequest() # InvoiceChargeRequest | The charge request

try: 
    # Invoice any outstanding charges for the subscription.
    api_response = api_instance.invoice_charges_on_subscription(subscription_id, charge)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->invoice_charges_on_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str	ID of the subscription.
charge	InvoiceChargeRequest	The charge request

Return type

InvoicePagedMetadata

Authorization

No authorization required

HTTP request headers

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

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

migrate_subscription

SubscriptionPagedMetadata migrate_subscription(subscription_id, request)

Migrate the subscription to a new plan.

{"nickname":"Migrate","request":"migrateSubscriptionRequest.html", "response":"migrateSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | ID of the subscription.
request = billforward.MigrationRequest() # MigrationRequest | The migration request

try: 
    # Migrate the subscription to a new plan.
    api_response = api_instance.migrate_subscription(subscription_id, request)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->migrate_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str	ID of the subscription.
request	MigrationRequest	The migration request

Return type

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

Authorization

No authorization required

HTTP request headers

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

remove_coupon_from_subscription

CouponPagedMetadata remove_coupon_from_subscription(subscription_id, coupon_code, organizations=organizations)

Removes the coupon from the subscription.

{"nickname":"Remove coupon","response":"removeCouponResponse.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
coupon_code = 'coupon_code_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)

try: 
    # Removes the coupon from the subscription.
    api_response = api_instance.remove_coupon_from_subscription(subscription_id, coupon_code, organizations=organizations)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->remove_coupon_from_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
coupon_code	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

remove_credit_from_subscription

CreditNotePagedMetadata remove_credit_from_subscription(subscription_id, value, organizations=organizations)

Decrease the amount of credit available to the specified subscription.

{"nickname":"Remove Credit","response":"removeCreditForSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
value = 'value_example' # str | <p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed.</p><p>If a decimal is provided this value will be removed from any credit available to the subscription. For example if the subscription is in USD setting the value as 10 will reduce credit by $10 (USD), setting 9.86  would reduce the credit by $9.86 (USD). The value will be reduced from any credit available.</p>
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)

try: 
    # Decrease the amount of credit available to the specified subscription.
    api_response = api_instance.remove_credit_from_subscription(subscription_id, value, organizations=organizations)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->remove_credit_from_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
value	str	<p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed.</p><p>If a decimal is provided this value will be removed from any credit available to the subscription. For example if the subscription is in USD setting the value as 10 will reduce credit by $10 (USD), setting 9.86 would reduce the credit by $9.86 (USD). The value will be reduced from any credit available.</p>
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

CreditNotePagedMetadata

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

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

remove_payment_method_from_subscription

PaymentMethodPagedMetadata remove_payment_method_from_subscription(subscription_id, payment_method_id, organizations=organizations)

Removes the specified payment method for the given subscription.

{"nickname":"Remove payment-method","response":"removePaymentMethod.html","request":"removePaymentMethod.request.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
payment_method_id = 'payment_method_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)

try: 
    # Removes the specified payment method for the given subscription.
    api_response = api_instance.remove_payment_method_from_subscription(subscription_id, payment_method_id, organizations=organizations)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->remove_payment_method_from_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
payment_method_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

remove_pricing_component_value_change_from_subscription

PaymentMethodPagedMetadata remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, organizations=organizations)

Discards from the subscription any scheduled changes in the value of the specified pricing-component.

{"nickname":"Discard value changes","response":"removePricingComponentValueChange.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
pricing_component = 'pricing_component_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)

try: 
    # Discards from the subscription any scheduled changes in the value of the specified pricing-component.
    api_response = api_instance.remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, organizations=organizations)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->remove_pricing_component_value_change_from_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
pricing_component	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain, application/json
Accept: application/json

resume_subscription

SubscriptionPagedMetadata resume_subscription(subscription_id, request)

Resume the frozen subscription.

{"nickname":"Resume","request":"resumeSubscriptionRequest.html","response":"resumeSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | ID of the subscription.
request = billforward.ResumeRequest() # ResumeRequest | The request

try: 
    # Resume the frozen subscription.
    api_response = api_instance.resume_subscription(subscription_id, request)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->resume_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str	ID of the subscription.
request	ResumeRequest	The request

Return type

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

Authorization

No authorization required

HTTP request headers

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

revive_subscription

SubscriptionPagedMetadata revive_subscription(subscription_id, request)

Revives a cancelled subscription and returns it to its previous state

{"nickname":"Revive subscription","request":"reviveSubscriptionRequest.html", "response":"reviveSubscription.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
request = billforward.ReviveSubscriptionRequest() # ReviveSubscriptionRequest | The revive request

try: 
    # Revives a cancelled subscription and returns it to its previous state
    api_response = api_instance.revive_subscription(subscription_id, request)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->revive_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str
request	ReviveSubscriptionRequest	The revive request

Return type

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

Authorization

No authorization required

HTTP request headers

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

set_metadata_for_subscription

DynamicMetadata set_metadata_for_subscription(metadata, subscription_id, organizations=organizations)

Remove any existing metadata keys and create the provided data.

{"nickname":"Set on subscription","request":"setSubscriptionMetadataRequest.html","response":"setSubscriptionMetadataResponse.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
metadata = billforward.DynamicMetadata() # DynamicMetadata | 
subscription_id = 'subscription_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)

try: 
    # Remove any existing metadata keys and create the provided data.
    api_response = api_instance.set_metadata_for_subscription(metadata, subscription_id, organizations=organizations)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->set_metadata_for_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
metadata	DynamicMetadata
subscription_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type

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

Authorization

No authorization required

HTTP request headers

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

set_pricing_component_value_on_subscription

PricingComponentValuePagedMetadata set_pricing_component_value_on_subscription(subscription_id, pricing_component_value)

Sets upon this subscription a new value for the specified pricing-component without performing an upgrade.

{"nickname":"Set values","request":"setPricingComponentValuesRequest.html","response":"setPricingComponentValues.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | ID of the subscription.
pricing_component_value = billforward.PricingComponentValue() # PricingComponentValue | The pricing-component-value request

try: 
    # Sets upon this subscription a new value for the specified pricing-component without performing an upgrade.
    api_response = api_instance.set_pricing_component_value_on_subscription(subscription_id, pricing_component_value)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription_id	str	ID of the subscription.
pricing_component_value	PricingComponentValue	The pricing-component-value request

Return type

PricingComponentValuePagedMetadata

Authorization

No authorization required

HTTP request headers

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

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

set_pricing_component_value_on_subscription_v2

PricingComponentValueResponsePagedMetadata set_pricing_component_value_on_subscription_v2(subscription_id, pricing_component, value)

Upgrades/downgrades this subscription to some new value for the specified pricing-component.

{"nickname":"Set value","request":"setPricingComponentValueRequest.html","response":"setPricingComponentValue.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription_id = 'subscription_id_example' # str | 
pricing_component = 'pricing_component_example' # str | Name or ID of the pricing-component.
value = billforward.PricingComponentValueRequest() # PricingComponentValueRequest | The pricing-component-value request

try: 
    # Upgrades/downgrades this subscription to some new value for the specified pricing-component.
    api_response = api_instance.set_pricing_component_value_on_subscription_v2(subscription_id, pricing_component, value)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription_v2: %s\n" % e

Parameters

Name	Type	Description
subscription_id	str
pricing_component	str	Name or ID of the pricing-component.
value	PricingComponentValueRequest	The pricing-component-value request

Return type

PricingComponentValueResponsePagedMetadata

Authorization

No authorization required

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_subscription

SubscriptionPagedMetadata update_subscription(subscription)

Update a subscription.

{"nickname":"Update a subscription","request":"updateSubscriptionRequest.html","response":"updateSubscriptionResponse.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
subscription = billforward.Subscription() # Subscription | The subscription object to be updated.

try: 
    # Update a subscription.
    api_response = api_instance.update_subscription(subscription)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->update_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
subscription	Subscription	The subscription object to be updated.

Return type

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

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: text/xml, application/xml, application/json

update_subscription_v2

SubscriptionPagedMetadata update_subscription_v2(request)

Update a subscription (V2).

{"nickname":"Update subscription (V2)","response":"updateSubscriptionViaHelper.html","request":"updateSubscriptionViaHelper.request.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
request = billforward.UpdateSubscriptionRequest() # UpdateSubscriptionRequest | 

try: 
    # Update a subscription (V2).
    api_response = api_instance.update_subscription_v2(request)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->update_subscription_v2: %s\n" % e

Parameters

Name	Type	Description	Notes
request	UpdateSubscriptionRequest

Return type

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

Authorization

No authorization required

HTTP request headers

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

upsert_metadata_for_subscription

DynamicMetadata upsert_metadata_for_subscription(metadata, subscription_id, organizations=organizations)

Update any existing metadata key-values and insert any new key-values, no keys will be removed.

{"nickname":"Upsert on subscription","request":"upsertSubscriptionMetadataRequest.html","response":"upsertSubscriptionMetadataResponse.html"}

Example

import time
import billforward
from billforward.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = billforward.SubscriptionsApi()
metadata = billforward.DynamicMetadata() # DynamicMetadata | 
subscription_id = 'subscription_id_example' # str | 
organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional)

try: 
    # Update any existing metadata key-values and insert any new key-values, no keys will be removed.
    api_response = api_instance.upsert_metadata_for_subscription(metadata, subscription_id, organizations=organizations)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling SubscriptionsApi->upsert_metadata_for_subscription: %s\n" % e

Parameters

Name	Type	Description	Notes
metadata	DynamicMetadata
subscription_id	str
organizations	list[str]	A list of organization-IDs used to restrict the scope of API calls.	[optional]

Return type