CoursePriceService

class CoursePriceService

Methods

get_all_coupons	Get the coupons of a price.
create_coupon	Create a new coupon for a course price.
delete_coupon	Delete a coupon.
update_coupon	Update the given coupon with new values.
start_payment	Create a new payment for the current user.
pay_with_coupon	Pay for a course with a coupon.

get_all_coupons(*, price_id, extra_parameters=None)

Get the coupons of a price.

Parameters:

• price_id (str) – The price id for which you want to get all coupons.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CoursePriceService[AuthenticatedClient]) –

Returns:

The coupons (that the current user may see) of the price.

Return type:

Sequence[CouponWithCode | CouponWithoutCode]

create_coupon(json_body, *, price_id, extra_parameters=None)

Create a new coupon for a course price.

Parameters:

• json_body (Union[dict, list, CouponDataParser]) – The body of the request. See CouponDataParser for information about the possible fields. You can provide this data as a CouponDataParser or as a dictionary.

• price_id (str) – The price you want to create a coupon for.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CoursePriceService[AuthenticatedClient]) –

Returns:

The coupon created for this course price.

Return type:

CouponWithCode | CouponWithoutCode

delete_coupon(*, price_id, coupon_id, extra_parameters=None)

Delete a coupon.

Parameters:

• price_id (str) – The id of the price the coupon is connected to.

• coupon_id (str) – The id of the coupon you want to delete.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CoursePriceService[AuthenticatedClient]) –

Returns:

Nothing

Return type:

None

update_coupon(json_body, *, price_id, coupon_id, extra_parameters=None)

Update the given coupon with new values.

Parameters:

• json_body (Union[dict, list, CouponDataParser]) – The body of the request. See CouponDataParser for information about the possible fields. You can provide this data as a CouponDataParser or as a dictionary.

• price_id (str) – The price to which the coupon is connected.

• coupon_id (str) – The id of the coupon you want to update.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CoursePriceService[AuthenticatedClient]) –

Returns:

The updated coupon

Return type:

CouponWithCode | CouponWithoutCode

start_payment(json_body, *, price_id, extra_parameters=None)

Create a new payment for the current user.

Parameters:

• json_body (Union[dict, list, StartPaymentCoursePriceRedirectData, StartPaymentCoursePriceCloseTabData]) – The body of the request. See StartPaymentCoursePriceData for information about the possible fields. You can provide this data as a StartPaymentCoursePriceData or as a dictionary.

• price_id (str) – The price you want to pay for.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CoursePriceService[AuthenticatedClient]) –

Returns:

A transaction for this course price with a stripe_url key that can be used to pay. Be careful to check the state of the transaction, as a payment might already be in progress.

Return type:

StartedTransaction

pay_with_coupon(json_body, *, price_id, extra_parameters=None)

Pay for a course with a coupon.

Parameters:

• json_body (Union[dict, list, PayWithCouponCoursePriceData]) – The body of the request. See PayWithCouponCoursePriceData for information about the possible fields. You can provide this data as a PayWithCouponCoursePriceData or as a dictionary.

• price_id (str) – The id of the price you want to pay for.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CoursePriceService[AuthenticatedClient]) –

Returns:

Nothing

Return type:

TenantCouponUsage | CourseCouponUsage