Paywalls commands

These Adapty CLI commands manage paywalls and the products each paywall sells.

adapty paywalls list

List all paywalls for an app.

adapty paywalls list --app <app-id>
FlagRequiredDescription
--appYesApp ID (UUID)

Accepts pagination flags.

adapty paywalls get

Get details for a specific paywall.

adapty paywalls get --app <app-id> <paywall-id>
ArgumentDescription
paywall-idPaywall ID (UUID)
FlagRequiredDescription
--appYesApp ID (UUID)

adapty paywalls create

Create a new paywall.

adapty paywalls create --app <app-id> --title "Default Paywall" --product-id <product-id>
FlagRequiredDescription
--appYesApp ID (UUID)
--titleYesPaywall title
--product-idYesProduct ID (UUID). Repeat for multiple products: --product-id <id1> --product-id <id2>

adapty paywalls update

Replace all fields of an existing paywall.

Important

Once a paywall is linked to a placement, its products cannot be changed. To use different products in a live paywall, create a new paywall and update the placement to point to it.

adapty paywalls update --app <app-id> <paywall-id> --title "Default Paywall" --product-id <product-id>

This command replaces all paywall fields, including the full product list.

ArgumentDescription
paywall-idPaywall ID (UUID)
FlagRequiredDescription
--appYesApp ID (UUID)
--titleYesPaywall title
--product-idYesProduct ID (UUID). Repeat for multiple products: --product-id <id1> --product-id <id2>

adapty paywalls placements

List all placements that currently use a given paywall.

adapty paywalls placements --app <app-id> <paywall-id>
ArgumentDescription
paywall-idPaywall ID (UUID)
FlagRequiredDescription
--appYesApp ID (UUID)

Use this command before swapping a paywall to see which placements would be affected.

The items in this list carry no is_active field. To read a placement’s activation state, use placements list or placements get.

What’s next