Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.
Filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
original : str
Filter by original field.
state : str
Filter by state field.
type : str
Filter by type field.
Returns
-------
Pager
A list of the subscription's line items.
"""
path = self._interpolate_path("/subscriptions/%s/line_items", subscription_id)
return Pager(self, path, kwargs)
Filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
type : str
Filter by type when:
- `type=charge`, only charge invoices will be returned.
- `type=credit`, only credit invoices will be returned.
- `type=non-legacy`, only charge and credit invoices will be returned.
- `type=legacy`, only legacy invoices will be returned.
Returns
-------
Pager
A list of the account's invoices.
"""
path = self._interpolate_path("/accounts/%s/invoices", account_id)
return Pager(self, path, kwargs)
def list_related_invoices(self, invoice_id, **kwargs):
"""List an invoice's related credit or charge invoices
Parameters
----------
invoice_id : str
Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`.
Returns
-------
Pager
A list of the credit or charge invoices associated with the invoice.
"""
path = self._interpolate_path("/invoices/%s/related_invoices", invoice_id)
return Pager(self, path, kwargs)
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
begin_time : datetime
Filter by begin_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
end_time : datetime
Filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
Returns
-------
Pager
A list of the site's shipping methods.
"""
path = self._interpolate_path("/shipping_methods")
return Pager(self, path, kwargs)
begin_time : datetime
Filter by begin_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
end_time : datetime
Filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
state : str
Filter by state.
Returns
-------
Pager
A list of the site's items.
"""
path = self._interpolate_path("/items")
return Pager(self, path, kwargs)
begin_time : datetime
Filter by begin_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
end_time : datetime
Filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
state : str
Filter by state.
Returns
-------
Pager
A list of add-ons.
"""
path = self._interpolate_path("/add_ons")
return Pager(self, path, kwargs)
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
end_time : datetime
Filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
type : str
Filter by type field. The value `payment` will return both `purchase` and `capture` transactions.
success : str
Filter by success field.
Returns
-------
Pager
A list of the site's transactions.
"""
path = self._interpolate_path("/transactions")
return Pager(self, path, kwargs)
Filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
state : str
Filter by state.
- When `state=active`, `state=canceled`, `state=expired`, or `state=future`, subscriptions with states that match the query and only those subscriptions will be returned.
- When `state=in_trial`, only subscriptions that have a trial_started_at date earlier than now and a trial_ends_at date later than now will be returned.
- When `state=live`, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
Returns
-------
Pager
A list of the site's subscriptions.
"""
path = self._interpolate_path("/subscriptions")
return Pager(self, path, kwargs)
Filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
original : str
Filter by original field.
state : str
Filter by state field.
type : str
Filter by type field.
Returns
-------
Pager
A list of the account's line items.
"""
path = self._interpolate_path("/accounts/%s/line_items", account_id)
return Pager(self, path, kwargs)
begin_time : datetime
Filter by begin_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
end_time : datetime
Filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
state : str
Filter by state.
Returns
-------
Pager
A list of add-ons.
"""
path = self._interpolate_path("/plans/%s/add_ons", plan_id)
return Pager(self, path, kwargs)