Skip to content

Latest commit

 

History

History
224 lines (160 loc) · 5.94 KB

SubscriptionProductService.md

File metadata and controls

224 lines (160 loc) · 5.94 KB

SubscriptionProductService

A list of all methods in the SubscriptionProductService service. Click on the method name to view detailed information about that method.

Methods Description
get_products_list Retrieve a list of all products.
create_product Create goods or services.
get_product Retrieve details of a product or service.
update_product Change or modify a product or service.
delete_product Delete a product or service from the Rapyd platform. This action also deletes all associated plans.

get_products_list

Retrieve a list of all products.

  • HTTP Method: GET
  • Endpoint: /v1/products

Parameters

Name Type Required Description
ending_before float ❌ The ID of the products created after the last product you want to retrieve.
limit float ❌ The maximum number of products to return. Range 1-100. Default is 10.
starting_after str ❌ The ID of the product created before the first products you want to retrieve.

Return Type

InlineResponse200_61

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.subscription_product.get_products_list(
    ending_before=2.82,
    limit=9.32,
    starting_after="starting_after"
)

print(result)

create_product

Create goods or services.

  • HTTP Method: POST
  • Endpoint: /v1/products

Parameters

Name Type Required Description
request_body V1ProductsBody ✅ The request body.

Return Type

InlineResponse200_62

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import V1ProductsBody

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = V1ProductsBody(
    active=True,
    attributes=[
        "attributes"
    ],
    description="description",
    id_="id",
    images=[
        "images"
    ],
    metadata={},
    name="name",
    package_dimensions={
        "height": 5.88,
        "length": 3.28,
        "weight": 1.4,
        "width": 7.3
    },
    shippable=True,
    statement_descriptor="statement_descriptor",
    type_="services",
    unit_label="unit_label"
)

result = sdk.subscription_product.create_product(request_body=request_body)

print(result)

get_product

Retrieve details of a product or service.

  • HTTP Method: GET
  • Endpoint: /v1/products/{products_id}

Parameters

Name Type Required Description
products_id str ✅ ID of the product.

Return Type

InlineResponse200_62

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.subscription_product.get_product(products_id="products_id")

print(result)

update_product

Change or modify a product or service.

  • HTTP Method: POST
  • Endpoint: /v1/products/{products_id}

Parameters

Name Type Required Description
request_body ProductsProductsIdBody ❌ The request body.
products_id str ✅ ID of the product.

Return Type

InlineResponse200_62

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import ProductsProductsIdBody

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = ProductsProductsIdBody(
    active=False,
    attributes=[
        "attributes"
    ],
    metadata={},
    name="name",
    package_dimensions={
        "height": 5.88,
        "length": 3.28,
        "weight": 1.4,
        "width": 7.3
    },
    statement_descriptor="statement_descriptor",
    unit_label="unit_label"
)

result = sdk.subscription_product.update_product(
    request_body=request_body,
    products_id="products_id"
)

print(result)

delete_product

Delete a product or service from the Rapyd platform. This action also deletes all associated plans.

  • HTTP Method: DELETE
  • Endpoint: /v1/products/{products_id}

Parameters

Name Type Required Description
products_id str ✅ ID of the product.

Return Type

InlineResponse200_60

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.subscription_product.delete_product(products_id="products_id")

print(result)