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, either for the course directly or for a tenant-wide access pass.
pay_with_coupon	Pay for a course with a coupon.

get_all_coupons(*, price_id, page_size=20)

Get the coupons of a price.

Parameters:

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

• page_size (int) – The size of a single page, maximum is 50.

• self (CoursePriceService[AuthenticatedClient])

Returns:

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

Return type:

Response[CouponWithCode | CouponWithoutCode]

create_coupon(json_body, *, price_id)

Create a new coupon for a course price.

Parameters:

• json_body (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.

• self (CoursePriceService[AuthenticatedClient])

Returns:

The coupon created for this course price.

Return type:

CouponWithCode | CouponWithoutCode

delete_coupon(*, price_id, coupon_id)

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.

• self (CoursePriceService[AuthenticatedClient])

Returns:

Nothing

Return type:

None

update_coupon(json_body, *, price_id, coupon_id)

Update the given coupon with new values.

Parameters:

• json_body (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.

• self (CoursePriceService[AuthenticatedClient])

Returns:

The updated coupon

Return type:

CouponWithCode | CouponWithoutCode

start_payment(json_body, *, price_id)

Create a new payment for the current user, either for the course directly or for a tenant-wide access pass.

Parameters:

• json_body (Union[StartPaymentCloseTabData, StartPaymentRedirectData]) – 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 of the course you want to gain access to.

• self (CoursePriceService[AuthenticatedClient])

Returns:

A transaction object with a payment_url key that can be used to complete the payment.

Return type:

StartedTransaction

pay_with_coupon(json_body, *, price_id)

Pay for a course with a coupon.

Parameters:

• json_body (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.

• self (CoursePriceService[AuthenticatedClient])

Returns:

Nothing

Return type:

TenantCouponUsage | CourseCouponUsage