paddle_update_customer_address: Update a Customer Address

View source: R/customers.R

paddle_update_customer_addressR Documentation

Update a Customer Address

Description

Updates an address for a specific customer using Paddle's API.

Usage

paddle_update_customer_address(
  id,
  address_id,
  country_code = NULL,
  description = NULL,
  first_line = NULL,
  second_line = NULL,
  city = NULL,
  postal_code = NULL,
  region = NULL,
  custom_data = NULL,
  status = NULL
)

Arguments

id

Character. Paddle customer ID (e.g., "ctm_123"). Required.

address_id

Character. Paddle address ID (e.g., "add_456"). Required.

country_code

Character. Optional. Two-letter ISO 3166-1 alpha-2 country code.

description

Character. Optional. Internal reference.

first_line

Character. Optional. First line of address.

second_line

Character. Optional. Second line of address.

city

Character. Optional. City name.

postal_code

Character. Optional. ZIP or postal code.

region

Character. Optional. Region, state, or county.

custom_data

Named list. Optional structured metadata.

status

Character. Status of the customer ('"active"' or '"archived"'). Optional.

Value

A list containing the updated address entity and metadata.

Examples


set_paddle_mode("sandbox")
result <- paddle_update_customer_address(
  id = "ctm_123",
  address_id = "add_123",
  city = "San Francisco",
  region = "CA"
)


paddleR documentation built on June 24, 2025, 9:07 a.m.